grails.plugin.searchable.internal.compass.support.SearchableMethodUtils.java Source code

Introduction

Here is the source code for grails.plugin.searchable.internal.compass.support.SearchableMethodUtils.java

Source

/*
 * Copyright 2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package grails.plugin.searchable.internal.compass.support;

import groovy.lang.Closure;

import java.util.HashMap;
import java.util.Map;

import org.springframework.util.Assert;

/**
 * @author Maurice Nicholson
 */
public abstract class SearchableMethodUtils {

    /**
     * Get the options Map from the given argument array
     * @param args the given array of arguments, may not be null, may be empty
     * @param defaultOptions the default options, to be merged with user options, may be null
     * @return a Map of options, never null
     */
    public static Map getOptionsArgument(Object[] args, Map defaultOptions) {
        Assert.notNull(args, "args cannot be null");
        Map options = null;
        for (int i = 0, max = args.length; i < max; i++) {
            if (args[i] instanceof Map) {
                options = (Map) args[i];
                break;
            }
        }
        Map merged = new HashMap();
        if (defaultOptions != null) {
            merged.putAll(defaultOptions);
        }
        if (options != null) {
            merged.putAll(options);
        }
        return merged;
    }

    /**
     * Get the options Map from the given argument array
     * @param args the given array of arguments, may not be null, may be empty
     * @param defaultOptions the default options, to be merged with user options, may be null
     * @param overrideWithDefaultsIfNull an array of keys which if null in the given options
     * are overriden with defaults
     * @return a Map of options, never null
     */
    public static Map getOptionsArgument(Object[] args, Map defaultOptions, String[] overrideWithDefaultsIfNull) {
        Map options = getOptionsArgument(args, defaultOptions);
        if (overrideWithDefaultsIfNull != null) {
            for (int i = 0; i < overrideWithDefaultsIfNull.length; i++) {
                String key = overrideWithDefaultsIfNull[i];
                if (options.containsKey(key) && options.get(key) == null) {
                    options.put(key, defaultOptions.get(key));
                }
            }
        }
        return options;
    }

    /**
     * Get the query argument - either a String or Closure
     * @param args
     * @return
     */
    public static Object getQueryArgument(Object args) {
        if (args instanceof String || args instanceof Closure) {
            return args;
        }
        Object[] argv = (Object[]) args;
        for (int i = 0, max = argv.length; i < max; i++) {
            if (argv[i] instanceof Closure || argv[i] instanceof String) {
                return argv[i];
            }
        }
        return null;
    }

    /**
     * Gets the named boolean from the given map if present,
     * otherwise the default value.
     * Handles wrapped (Boolean) instances and converts "true" and "false" Strings
     * to booleans
     * @param options the Map containing the named entry
     * @param name the entry name
     * @param defaultValue the default if not present in options Map
     * @return the boolean
     */
    public static boolean getBool(Map options, String name, boolean defaultValue) {
        Object value = options.get(name);
        if (value == null) {
            return defaultValue;
        }
        if (value instanceof Boolean) {
            return (Boolean) value;
        }
        if (value instanceof String) {
            return Boolean.valueOf((String) value);
        }
        throw new IllegalArgumentException("The value of option [" + name
                + "] should be a boolean (or string equivalent) but is [" + value.getClass() + "]");
    }
}