Field Detail

• log

  public static final org.slf4j.Logger log

Method Detail

• setPublicFieldsFromFlags

  public static java.util.Map<?,?> setPublicFieldsFromFlags(java.util.Map<?,?> flags,
                                            java.lang.Object o)

  see setFieldsFromFlags(Object o, ConfigBag)

• setFieldsFromFlags

  public static java.util.Map<?,?> setFieldsFromFlags(java.util.Map<?,?> flags,
                                      java.lang.Object o)

  see setFieldsFromFlags(Object, ConfigBag)

• setFieldsFromFlags

  public static void setFieldsFromFlags(java.lang.Object o,
                        ConfigBag configBag)

  sets all fields (including private and static, local and inherited) annotated SetFromFlag on the given object, from the given flags map, returning just those flag-value pairs passed in which do not correspond to SetFromFlags fields annotated ConfigKey and HasConfigKey fields are _configured_ (and we assume the object in that case is Configurable); keys should be ConfigKey, HasConfigKey, or String; default values are also applied unless that is specified false on one of the variants of this method which takes such an argument

• setFieldsFromFlags

  public static void setFieldsFromFlags(java.lang.Object o,
                        ConfigBag configBag,
                        boolean setDefaultVals)

  as setFieldsFromFlags(Object, ConfigBag), but allowing control over whether default values should be set

• setFieldsFromFlagsWithBag

  public static void setFieldsFromFlagsWithBag(java.lang.Object o,
                               java.util.Map<?,?> flags,
                               ConfigBag configBag,
                               boolean setDefaultVals)

  as setFieldsFromFlags(Object, ConfigBag), but specifying a subset of flags to use

• setFieldFromFlag

  public static boolean setFieldFromFlag(java.lang.Object o,
                         java.lang.String flagName,
                         java.lang.Object fieldVal)

  Sets the field with the given flag (if it exists) to the given value. Will attempt to coerce the value to the required type. Will respect "nullable" on the SetFromFlag annotation.

  Throws:

  java.lang.IllegalArgumentException - If fieldVal is null and the SetFromFlag annotation set nullable=false

• getFieldsWithFlags

  public static java.util.Map<java.lang.String,?> getFieldsWithFlags(java.lang.Object o)

  get all fields (including private and static) on the given object and all supertypes, that are annotated with SetFromFlags.

• findFieldForFlag

  public static java.lang.reflect.Field findFieldForFlag(java.lang.String flagName,
                                         java.lang.Object o)

  Finds the Field on the given object annotated with the given name flag.

• getFieldsWithFlagsExcludingModifiers

  public static java.util.Map<java.lang.String,java.lang.Object> getFieldsWithFlagsExcludingModifiers(java.lang.Object o,
                                                                                      int excludingModifiers)

  get all fields (including private and static) and their values on the given object and all supertypes, where the field is annotated with SetFromFlags.

• getFieldsWithFlagsWithModifiers

  public static java.util.Map<java.lang.String,java.lang.Object> getFieldsWithFlagsWithModifiers(java.lang.Object o,
                                                                                 int requiredModifiers)

  get all fields with the given modifiers, and their values on the given object and all supertypes, where the field is annotated with SetFromFlags.

• setAllConfigKeys

  public static java.util.Map<java.lang.String,?> setAllConfigKeys(java.util.Map<java.lang.String,?> flagsOrConfig,
                                                   Configurable instance)

  Deprecated. since 0.7.0 use setAllConfigKeys(Map, Configurable, boolean)
  sets _all_ accessible _ConfigKey_ and ConfigKey.HasConfigKey fields on the given object, using the indicated flags/config-bag

• setAllConfigKeys

  public static java.util.Map<java.lang.String,?> setAllConfigKeys(java.util.Map<java.lang.String,?> flagsOrConfig,
                                                   Configurable instance,
                                                   boolean includeFlags)

  sets _all_ accessible _ConfigKey_ and ConfigKey.HasConfigKey fields on the given object, using the indicated flags/config-bag

• setAllConfigKeys

  public static void setAllConfigKeys(Configurable o,
                      ConfigBag bag)

  Deprecated. since 0.7.0 use setAllConfigKeys(Configurable, ConfigBag, boolean)
  sets _all_ accessible _ConfigKey_ and ConfigKey.HasConfigKey fields on the given object, using the indicated flags/config-bag

• setAllConfigKeys

  public static void setAllConfigKeys(Configurable o,
                      ConfigBag bag,
                      boolean includeFlags)

  sets _all_ accessible _ConfigKey_ and ConfigKey.HasConfigKey fields on the given object, using the indicated flags/config-bag

• findAllFlagsAndConfigKeys

  public static <T> java.util.List<FlagUtils.FlagConfigKeyAndValueRecord> findAllFlagsAndConfigKeys(T optionalInstance,
                                                                                    java.lang.Class<? extends T> type,
                                                                                    ConfigBag input)

  gets all the flags/keys in the given config bag which are applicable to the given type's config keys and flags

• getAllFields

  public static java.util.List<java.lang.reflect.Field> getAllFields(java.lang.Class<?> base,
                                                     groovy.lang.Closure<java.lang.Boolean> filter)

  returns all fields on the given class, superclasses, and interfaces thereof, in that order of preference, (excluding fields on Object)

• getAllFields

  public static java.util.List<java.lang.reflect.Field> getAllFields(java.lang.Class<?> base)

• getAllFields

  public static java.util.List<java.lang.reflect.Field> getAllFields(java.lang.Class<?> base,
                                                     com.google.common.base.Predicate<java.lang.reflect.Field> filter)

• getLocalFields

  public static java.util.List<java.lang.reflect.Field> getLocalFields(java.util.List<java.lang.Class<?>> classes)

  returns all fields explicitly declared on the given classes

• getLocalFields

  public static java.util.List<java.lang.reflect.Field> getLocalFields(java.util.List<java.lang.Class<?>> classes,
                                                       groovy.lang.Closure<java.lang.Boolean> filter)

• getLocalFields

  public static java.util.List<java.lang.reflect.Field> getLocalFields(java.util.List<java.lang.Class<?>> classes,
                                                       com.google.common.base.Predicate<java.lang.reflect.Field> filter)

• getAllAssignableTypes

  public static java.util.List<java.lang.Class<?>> getAllAssignableTypes(java.lang.Class<?> base)

  returns base, superclasses, then interfaces

• getAllAssignableTypes

  public static java.util.List<java.lang.Class<?>> getAllAssignableTypes(java.lang.Class<?> base,
                                                         groovy.lang.Closure<java.lang.Boolean> filter)

• getAllAssignableTypes

  public static java.util.List<java.lang.Class<?>> getAllAssignableTypes(java.lang.Class<?> base,
                                                         com.google.common.base.Predicate<java.lang.Class<?>> filter)

• setConfig

  public static void setConfig(java.lang.Object objectOfField,
               ConfigKey<?> key,
               java.lang.Object value,
               SetFromFlag optionalAnnotation)

• setField

  public static void setField(java.lang.Object objectOfField,
              java.lang.reflect.Field f,
              java.lang.Object value,
              SetFromFlag optionalAnnotation)

  sets the field to the value, after checking whether the given value can be set respecting the constraints of the annotation

• getField

  public static java.lang.Object getField(java.lang.Object objectOfField,
                          java.lang.reflect.Field f)

  gets the value of the field.

• getDefaultValueForType

  public static java.lang.Object getDefaultValueForType(java.lang.Class<?> t)

  returns the default/inital value that is assigned to fields of the givien type; if the type is not primitive this value is null; for primitive types it is obvious but not AFAIK programmatically visible (e.g. 0 for int, false for boolean)

• getAnnotatedFields

  public static java.util.Map<java.lang.reflect.Field,SetFromFlag> getAnnotatedFields(java.lang.Class<?> type)

  returns a map of all fields which are annotated 'SetFromFlag', along with the annotation

• getAnnotatedConfigKeys

  public static java.util.Map<ConfigKey<?>,SetFromFlag> getAnnotatedConfigKeys(java.lang.Class<?> type)

  returns a map of all ConfigKey fields which are annotated 'SetFromFlag', along with the annotation

• getFieldsWithValues

  public static java.util.Map<java.lang.String,java.lang.Object> getFieldsWithValues(java.lang.Object o)

  returns a map of all fields which are annotated 'SetFromFlag' with their current values; useful if you want to clone settings from one object

• checkRequiredFields

  public static void checkRequiredFields(java.lang.Object o)

  Throws:

  an - IllegalStateException if there are fields required (nullable=false) which are unset

  wrapped - IllegalAccessException