GriffonClassUtils (Griffon 2.2.0)

java.lang.Object
- griffon.util.GriffonClassUtils

```
public class GriffonClassUtils
extends Object
```
Class containing utility methods for dealing with Griffon class artifacts.
Contains utility methods copied from commons-lang and commons-beanutils in order to reduce dependencies on external libraries.

Contains code copied from commons-beanutils and commons-langs

Author:

Graeme Rocher (Grails 0.1)

Field Summary

Fields
Modifier and Type	Field and Description
`static Object[]`	`EMPTY_ARGS`
`static Class<?>[]`	`EMPTY_CLASS_ARRAY`
`static Object[]`	`EMPTY_OBJECT_ARRAY`
`static String`	`INNER_CLASS_SEPARATOR` The inner class separator String: `"$"`.
`static char`	`INNER_CLASS_SEPARATOR_CHAR` The inner class separator character: `'$' == 36`.
`static String`	`PACKAGE_SEPARATOR` The package separator String: `"."`.
`static char`	`PACKAGE_SEPARATOR_CHAR` The package separator character: `'.' == 46`.
`static Map<Class<?>,Class<?>>`	`PRIMITIVE_TYPE_COMPATIBLE_CLASSES`
`static Map<String,String>`	`PRIMITIVE_TYPE_COMPATIBLE_TYPES`

Constructor Summary

Constructors
Constructor and Description

GriffonClassUtils()

Constructors
Constructor and Description
`GriffonClassUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Object[]`	`collectionToObjectArray(Collection<?> c)` Convenience method for converting a collection to an Object[]
`static Class<?>[]`	`convertToTypeArray(Object[] args)` param instance array to the type array
`static Collection<?>`	`createConcreteCollection(Class<?> interfaceType)` Creates a concrete collection for the supplied interface
`static boolean`	`getBooleanFromMap(String key, Map<String,Object> map)` Retrieves a boolean value from a Map for the given key
`static Field`	`getField(Class<?> clazz, String name)` Get the a declared field on a class
`static Field`	`getField(Object obj, String name)` Get the a declared field on an object
`static Object`	`getFieldValue(Object obj, String name)` Get the value of a declared field on an object
`static String`	`getGetterName(String propertyName)` Calculate the name for a getter method to retrieve the specified property
`static String`	`getPackageName(Class<?> cls)` Gets the package name of a `Class`.
`static String`	`getPackageName(Object object, String valueIfNull)` Gets the package name of an `Object`.
`static String`	`getPackageName(String className)` Gets the package name from a `String`.
`static PropertyDescriptor[]`	`getPropertiesAssignableToType(Class<?> clazz, Class<?> propertySuperType)` Retrieves all the properties of the given class which are assignable to the given type
`static PropertyDescriptor[]`	`getPropertiesOfType(Class<?> clazz, Class<?> propertyType)` Retrieves all the properties of the given class for the given type
`static PropertyDescriptor`	`getProperty(Class<?> clazz, String propertyName, Class<?> propertyType)` Retrieves a property of the given class of the specified name and type
`static Object`	`getProperty(Object bean, String name)` Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.
`static PropertyDescriptor`	`getPropertyDescriptor(Class<?> clazz, String name)` Retrieve the property descriptor for the specified property of the specified class, or return `null` if there is no such descriptor.
`static PropertyDescriptor`	`getPropertyDescriptor(Object bean, String name)` Retrieve the property descriptor for the specified property of the specified bean, or return `null` if there is no such descriptor.
`static PropertyDescriptor`	`getPropertyDescriptorForValue(Object instance, Object propertyValue)` Retrieves a PropertyDescriptor for the specified instance and property value
`static PropertyDescriptor[]`	`getPropertyDescriptors(Class<?> beanClass)` Retrieve the property descriptors for the specified class, introspecting and caching them the first time a particular bean class is encountered.
`static String`	`getPropertyForGetter(String getterName)` Returns a property name equivalent for the given getter name or null if it is not a getter
`static String`	`getPropertyForSetter(String setterName)` Returns a property name equivalent for the given setter name or null if it is not a getter
`static Object`	`getPropertyOrStaticPropertyOrFieldValue(Object obj, String name)` Looks for a property of the reference instance with a given name.
`static Class<?>`	`getPropertyType(Class<?> clazz, String propertyName)` Returns the type of the given property contained within the specified class
`static Object`	`getPropertyValue(Object bean, String name)` Returns the value of a property.
`static Object`	`getPropertyValueOfNewInstance(Class<?> clazz, String propertyName)` Returns the value of the specified property and type from an instance of the specified Griffon class
`static Object`	`getPropertyValueOfNewInstance(Class<?> clazz, String propertyName, Class<?> propertyType)` Returns the value of the specified property and type from an instance of the specified Griffon class
`static Method`	`getReadMethod(Class<?> clazz, PropertyDescriptor descriptor)` Return an accessible property getter method for this property, if there is one; otherwise return `null`.
`static Method`	`getReadMethod(PropertyDescriptor descriptor)` Return an accessible property getter method for this property, if there is one; otherwise return `null`.
`static String`	`getSetterName(String propertyName)` Retrieves the name of a setter for the specified property name
`static String`	`getShortClassName(Class<?> cls)` Gets the class name minus the package name from a `Class`.
`static String`	`getShortClassName(Object object, String valueIfNull)` Gets the class name minus the package name for an `Object`.
`static String`	`getShortClassName(String className)` Gets the class name minus the package name from a String.
`static Object`	`getStaticPropertyValue(Class<?> clazz, String name)` Get a static property value, which has a public static getter or is just a public static field.
`static Method`	`getWriteMethod(Class<?> clazz, PropertyDescriptor descriptor)` Return an accessible property setter method for this property, if there is one; otherwise return `null`.
`static Method`	`getWriteMethod(PropertyDescriptor descriptor)` Return an accessible property setter method for this property, if there is one; otherwise return `null`.
`static Object`	`instantiate(Class<?> clazz, Object[] args)`
`static Object`	`instantiateClass(Class<?> clazz)` Instantiates a Class, wrapping any exceptions in a RuntimeException.
`static Object`	`invokeExactInstanceMethod(Object object, String methodName)`
`static Object`	`invokeExactInstanceMethod(Object object, String methodName, Object... args)`
`static Object`	`invokeExactInstanceMethod(Object object, String methodName, Object arg)`
`static Object`	`invokeExactStaticMethod(Class<?> type, String methodName)`
`static Object`	`invokeExactStaticMethod(Class<?> type, String methodName, Object... args)`
`static Object`	`invokeExactStaticMethod(Class<?> type, String methodName, Object arg)`
`static Object`	`invokeInstanceMethod(Object object, String methodName)`
`static Object`	`invokeInstanceMethod(Object object, String methodName, Object... args)`
`static Object`	`invokeInstanceMethod(Object object, String methodName, Object arg)`
`static Object`	`invokeStaticMethod(Class<?> type, String methodName)`
`static Object`	`invokeStaticMethod(Class<?> type, String methodName, Object... args)`
`static Object`	`invokeStaticMethod(Class<?> type, String methodName, Object arg)`
`static boolean`	`isArtifactMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined Artifact methods by convention.
`static boolean`	`isArtifactMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined Artifact methods by convention.
`static boolean`	`isAssignableOrConvertibleFrom(Class<?> clazz, Class<?> type)` Returns true if the specified clazz parameter is either the same as, or is a superclass or super interface of, the specified type parameter.
`static boolean`	`isBasicMethod(Method method)` Finds out if the given `Method` belongs either to the `Object` class or the `GroovyObject` class.
`static boolean`	`isBasicMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs either to the `Object` class or the `GroovyObject` class.
`static boolean`	`isClassBelowPackage(Class<?> clazz, List<?> packageList)` Returns whether the specified class is either within one of the specified packages or within a subpackage of one of the packages
`static boolean`	`isContributionMethod(Method method)` Finds out if the given Method represents a contribution method by matching its name against the following pattern: "^with[A-Z][a-z0-9_][\w]$"
`static boolean`	`isContributionMethod(MethodDescriptor method)` Finds out if the given Method represents a contribution method by matching its name against the following pattern: "^with[A-Z][a-z0-9_][\w]$"
`static boolean`	`isContributionMethod(String name)` Finds out if the given string represents the name of a contribution method by matching against the following pattern: "^with[A-Z][a-z0-9_][\w]$"
`static boolean`	`isEventHandler(Method method)` Finds out if the given Method represents an event handler by matching its name against the following pattern: "^on[A-Z][\\w]*$"
`static boolean`	`isEventHandler(MethodDescriptor method)` Finds out if the given Method represents an event handler by matching its name against the following pattern: "^on[A-Z][\\w]*$"
`static boolean`	`isEventHandler(String name)` Finds out if the given string represents the name of an event handler by matching against the following pattern: "^on[A-Z][\\w]*$"
`static boolean`	`isEventPublisherMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined event publisher methods by convention.
`static boolean`	`isEventPublisherMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined event publisher methods by convention.
`static boolean`	`isGetter(String name, Class[] args)` Returns true if the name of the method specified and the number of arguments make it a javabean property
`static boolean`	`isGetterMethod(Method method)` Finds out if the given `Method` is a getter method.
`static boolean`	`isGetterMethod(MethodDescriptor method)` Finds out if the given `MetaMethod` is a getter method.
`static boolean`	`isGroovyInjectedMethod(Method method)` Finds out if the given `Method` was injected by the Groovy compiler.
`static boolean`	`isGroovyInjectedMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` was injected by the Groovy compiler.
`static boolean`	`isInstanceMethod(Method method)` Finds out if the given `Method` is an instance method, i.e, it is public and non-static.
`static boolean`	`isInstanceMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` is an instance method, i.e, it is public and non-static.
`static boolean`	`isMatchBetweenPrimitiveAndWrapperTypes(Class<?> leftType, Class<?> rightType)` Detect if left and right types are matching types.
`static boolean`	`isMatchBetweenPrimitiveAndWrapperTypes(String leftType, String rightType)` Detect if left and right types are matching types.
`static boolean`	`isMessageSourceMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined message source methods by convention.
`static boolean`	`isMessageSourceMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined message source methods by convention.
`static boolean`	`isMvcMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined MVC methods by convention.
`static boolean`	`isMvcMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined MVC methods by convention.
`static boolean`	`isObservableMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined observable methods by convention.
`static boolean`	`isObservableMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined observable methods by convention.
`static boolean`	`isPlainMethod(Method method)` Finds out if the given `Method` matches the following criteria: isInstanceMethod(method) ! isBasicMethod(method) ! isGroovyInjectedMethod(method) ! isThreadingMethod(method) ! isArtifactMethod(method) ! isMvcMethod(method) ! isServiceMethod(method) ! isEventPublisherMethod(method) ! isObservableMethod(method) ! isResourceHandlerMethod(method) ! isGetterMethod(method) ! isSetterMethod(method) ! isContributionMethod(method)
`static boolean`	`isPlainMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` matches the following criteria: isInstanceMethod(method) ! isBasicMethod(method) ! isGroovyInjectedMethod(method) ! isThreadingMethod(method) ! isArtifactMethod(method) ! isMvcMethod(method) ! isServiceMethod(method) ! isEventPublisherMethod(method) ! isObservableMethod(method) ! isResourceHandlerMethod(method) ! isGetterMethod(method) ! isSetterMethod(method) ! isContributionMethod(method)
`static boolean`	`isPropertyInherited(Class<?> clz, String propertyName)` Checks whether the specified property is inherited from a super class
`static boolean`	`isPropertyOfType(Class<?> clazz, String propertyName, Class<?> type)` Returns true if the specified property in the specified class is of the specified type
`static boolean`	`isPublicField(Object obj, String name)` Work out if the specified object has a public field with the name supplied.
`static boolean`	`isPublicStatic(Field f)` Determine whether the field is declared public static
`static boolean`	`isPublicStatic(Method m)` Determine whether the method is declared public static
`static boolean`	`isReadable(Object bean, String name)` Return `true` if the specified property name identifies a readable property on the specified bean; otherwise, return `false`.
`static boolean`	`isResourceHandlerMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined resources methods by convention.
`static boolean`	`isResourceHandlerMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined resources methods by convention.
`static boolean`	`isResourceResolverMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined resource resolver methods by convention.
`static boolean`	`isResourceResolverMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined resource resolver methods by convention.
`static boolean`	`isSetter(String name, Class[] args)`
`static boolean`	`isSetterMethod(Method method)` Finds out if the given `Method` is a setter method.
`static boolean`	`isSetterMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` is a setter method.
`static boolean`	`isStaticProperty(Class<?> clazz, String propertyName)` Work out if the specified property is readable and static.
`static boolean`	`isThreadingMethod(Method method)` Finds out if the given `Method` belongs to the set of predefined threading methods by convention.
`static boolean`	`isThreadingMethod(MethodDescriptor method)` Finds out if the given `MethodDescriptor` belongs to the set of predefined threading methods by convention.
`static void`	`isTrue(boolean expression, String message)` Validate that the argument condition is `true`; otherwise throwing an exception with the specified message.
`static boolean`	`isWritable(Object bean, String name)` Return `true` if the specified property name identifies a writable property on the specified bean; otherwise, return `false`.
`static void`	`requireState(boolean condition)` Checks that the specified condition is met.
`static void`	`requireState(boolean condition, String message)` Checks that the specified condition is met and throws a customized `IllegalStateException` if it is.
`static void`	`setField(Object bean, String name, Object value)` Sets the value of the specified field of the specified bean.
`static void`	`setFieldOrPropertyValue(Object bean, String name, Object value)` Sets or updates an object's property.
`static void`	`setFields(Object bean, Map<String,Object> fields)` Sets or updates field values on an object.
`static void`	`setFieldsNoException(Object bean, Map<String,Object> fields)` Sets or updates field values on an object.
`static void`	`setFieldsOrProperties(Object bean, Map<String,Object> properties)` Sets or updates an object's properties.
`static void`	`setFieldsOrPropertiesNoException(Object bean, Map<String,Object> properties)` Sets or updates an object's properties.
`static void`	`setFieldValue(Object bean, String name, Object value)` Sets or updates an object's field.
`static void`	`setProperties(Object bean, Map<String,Object> properties)` Sets or updates properties on an object.
`static void`	`setPropertiesNoException(Object bean, Map<String,Object> properties)` Sets or updates properties on an object.
`static void`	`setPropertiesOrFields(Object bean, Map<String,Object> properties)` Sets or updates an object's properties.
`static void`	`setPropertiesOrFieldsNoException(Object bean, Map<String,Object> properties)` Sets or updates an object's properties.
`static void`	`setProperty(Object bean, String name, Object value)` Sets the value of the specified property of the specified bean.
`static void`	`setPropertyOrFieldValue(Object bean, String name, Object value)` Sets or updates an object's property.
`static void`	`setPropertyValue(Object bean, String name, Object value)` /** Sets or updates a property on an object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_CLASS_ARRAY

public static final Class<?>[] EMPTY_CLASS_ARRAY

EMPTY_OBJECT_ARRAY

public static final Object[] EMPTY_OBJECT_ARRAY

EMPTY_ARGS

public static final Object[] EMPTY_ARGS

PRIMITIVE_TYPE_COMPATIBLE_CLASSES

public static final Map<Class<?>,Class<?>> PRIMITIVE_TYPE_COMPATIBLE_CLASSES

PRIMITIVE_TYPE_COMPATIBLE_TYPES

public static final Map<String,String> PRIMITIVE_TYPE_COMPATIBLE_TYPES

PACKAGE_SEPARATOR_CHAR
```
public static final char PACKAGE_SEPARATOR_CHAR
```
The package separator character: '.' == 46.

See Also:

Constant Field Values

PACKAGE_SEPARATOR
```
public static final String PACKAGE_SEPARATOR
```
The package separator String: ".".

INNER_CLASS_SEPARATOR_CHAR
```
public static final char INNER_CLASS_SEPARATOR_CHAR
```
The inner class separator character: '$' == 36.

See Also:

Constant Field Values

INNER_CLASS_SEPARATOR
```
public static final String INNER_CLASS_SEPARATOR
```
The inner class separator String: "$".

Constructor Detail
- GriffonClassUtils
```
public GriffonClassUtils()
```

Method Detail

requireState
```
public static void requireState(boolean condition)
```
Checks that the specified condition is met. This method is designed primarily for doing parameter validation in methods and constructors, as demonstrated below:
```
 public Foo(int[] array) {
     GriffonClassUtils.requireState(array.length > 0);
 }
 
```
Parameters:

condition - the condition to check

Throws:

IllegalStateException - if condition evaluates to false

requireState
```
public static void requireState(boolean condition,
                                String message)
```
Checks that the specified condition is met and throws a customized IllegalStateException if it is. This method is designed primarily for doing parameter validation in methods and constructors with multiple parameters, as demonstrated below:
```
 public Foo(int[] array) {
     GriffonClassUtils.requireState(array.length > 0, "array must not be empty");
 }
 
```
Parameters:

condition - the condition to check

message - detail message to be used in the event that a IllegalStateException is thrown

Throws:

IllegalStateException - if condition evaluates to false

isEventHandler
```
public static boolean isEventHandler(@Nonnull
                                     String name)
```
Finds out if the given string represents the name of an event handler by matching against the following pattern: "^on[A-Z][\\w]*$"
```
 isEventHandler("onBootstrapEnd") = true
 isEventHandler("mvcGroupInit")   = false
 isEventHandler("online")         = false
 
```
Parameters:

name - the name of a possible event handler

Returns:

true if the name matches the given event handler pattern, false otherwise.

isEventHandler

public static boolean isEventHandler(@Nonnull
                                     Method method)

Finds out if the given Method represents an event handler by matching its name against the following pattern: "^on[A-Z][\\w]*$"

 // assuming getMethod() returns an appropriate Method reference
 isEventHandler(getMethod("onBootstrapEnd")) = true
 isEventHandler(getMethod("mvcGroupInit"))   = false
 isEventHandler(getMethod("online"))         = false

Parameters:: method - a Method reference
Returns:: true if the method name matches the given event handler pattern, false otherwise.

isEventHandler

public static boolean isEventHandler(@Nonnull
                                     MethodDescriptor method)

Finds out if the given Method represents an event handler by matching its name against the following pattern: "^on[A-Z][\\w]*$"

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isEventHandler(getMethod("onBootstrapEnd")) = true
 isEventHandler(getMethod("mvcGroupInit"))   = false
 isEventHandler(getMethod("online"))         = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method name matches the given event handler pattern, false otherwise.

isBasicMethod
```
public static boolean isBasicMethod(@Nonnull
                                    Method method)
```
Finds out if the given Method belongs either to the Object class or the GroovyObject class.

Parameters:

method - a Method reference

Returns:

true if the method belongs to Object or GroovyObject, false otherwise.

isContributionMethod
```
public static boolean isContributionMethod(@Nonnull
                                           String name)
```
Finds out if the given string represents the name of a contribution method by matching against the following pattern: "^with[A-Z][a-z0-9_]*[\w]*$"
```
 isContributionMethod("withRest")     = true
 isContributionMethod("withMVCGroup") = false
 isContributionMethod("without")      = false
 
```
Parameters:

name - the name of a possible contribution method

Returns:

true if the name matches the given contribution method pattern, false otherwise.

isContributionMethod

public static boolean isContributionMethod(@Nonnull
                                           Method method)

Finds out if the given Method represents a contribution method by matching its name against the following pattern: "^with[A-Z][a-z0-9_]*[\w]*$"

 // assuming getMethod() returns an appropriate Method reference
 isContributionMethod(getMethod("withRest"))     = true
 isContributionMethod(getMethod("withMVCGroup")) = false
 isContributionMethod(getMethod("without"))      = false

Parameters:: method - a Method reference
Returns:: true if the method name matches the given contribution method pattern, false otherwise.

isContributionMethod

public static boolean isContributionMethod(@Nonnull
                                           MethodDescriptor method)

Finds out if the given Method represents a contribution method by matching its name against the following pattern: "^with[A-Z][a-z0-9_]*[\w]*$"

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isContributionMethod(getMethod("withRest"))     = true
 isContributionMethod(getMethod("withMVCGroup")) = false
 isContributionMethod(getMethod("without"))      = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method name matches the given contribution method pattern, false otherwise.

isBasicMethod
```
public static boolean isBasicMethod(@Nonnull
                                    MethodDescriptor method)
```
Finds out if the given MethodDescriptor belongs either to the Object class or the GroovyObject class.

Parameters:

method - a MethodDescriptor reference

Returns:

true if the method belongs to Object or GroovyObject, false otherwise.

isGroovyInjectedMethod
```
public static boolean isGroovyInjectedMethod(@Nonnull
                                             Method method)
```
Finds out if the given Method was injected by the Groovy compiler.
Performs a basic checks against the method's name, returning true if the name starts with either "super$" or "this$".

Parameters:

method - a Method reference

Returns:

true if the method matches the given criteria, false otherwise.

isGroovyInjectedMethod
```
public static boolean isGroovyInjectedMethod(@Nonnull
                                             MethodDescriptor method)
```
Finds out if the given MethodDescriptor was injected by the Groovy compiler.
Performs a basic checks against the method's name, returning true if the name starts with either "super$" or "this$".

Parameters:

method - a MethodDescriptor reference

Returns:

true if the method matches the given criteria, false otherwise.

isGetterMethod

public static boolean isGetterMethod(@Nonnull
                                     Method method)

Finds out if the given Method is a getter method.

 // assuming getMethod() returns an appropriate Method reference
 isGetterMethod(getMethod("getFoo"))       = true
 isGetterMethod(getMethod("getfoo") )      = false
 isGetterMethod(getMethod("mvcGroupInit")) = false
 isGetterMethod(getMethod("isFoo"))        = true
 isGetterMethod(getMethod("island"))       = false

Parameters:: method - a Method reference
Returns:: true if the method is a getter, false otherwise.

isGetterMethod

public static boolean isGetterMethod(@Nonnull
                                     MethodDescriptor method)

Finds out if the given MetaMethod is a getter method.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isGetterMethod(getMethod("getFoo"))       = true
 isGetterMethod(getMethod("getfoo") )      = false
 isGetterMethod(getMethod("mvcGroupInit")) = false
 isGetterMethod(getMethod("isFoo"))        = true
 isGetterMethod(getMethod("island"))       = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is a getter, false otherwise.

isSetterMethod

public static boolean isSetterMethod(@Nonnull
                                     Method method)

Finds out if the given Method is a setter method.

 // assuming getMethod() returns an appropriate Method reference
 isGetterMethod(getMethod("setFoo"))       = true
 isGetterMethod(getMethod("setfoo"))       = false
 isGetterMethod(getMethod("mvcGroupInit")) = false

Parameters:: method - a Method reference
Returns:: true if the method is a setter, false otherwise.

isSetterMethod

public static boolean isSetterMethod(@Nonnull
                                     MethodDescriptor method)

Finds out if the given MethodDescriptor is a setter method.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isGetterMethod(getMethod("setFoo"))       = true
 isGetterMethod(getMethod("setfoo"))       = false
 isGetterMethod(getMethod("mvcGroupInit")) = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is a setter, false otherwise.

isArtifactMethod

public static boolean isArtifactMethod(@Nonnull
                                       Method method)

Finds out if the given Method belongs to the set of predefined Artifact methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isArtifactMethod(getMethod("newInstance"))    = true
 isArtifactMethod(getMethod("griffonDestroy")) = false
 isArtifactMethod(getMethod("foo"))            = false

Parameters:: method - a Method reference
Returns:: true if the method is an Artifact method, false otherwise.

isArtifactMethod

public static boolean isArtifactMethod(@Nonnull
                                       MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined Artifact methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isArtifactMethod(getMethod("newInstance"))    = true
 isArtifactMethod(getMethod("griffonDestroy")) = false
 isArtifactMethod(getMethod("foo"))            = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an Artifact method, false otherwise.

isMvcMethod

public static boolean isMvcMethod(@Nonnull
                                  Method method)

Finds out if the given Method belongs to the set of predefined MVC methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isMvcMethod(getMethod("mvcGroupInit"))    = true
 isMvcMethod(getMethod("mvcGroupDestroy")) = true
 isMvcMethod(getMethod("foo"))             = false

Parameters:: method - a Method reference
Returns:: true if the method is an MVC method, false otherwise.

isMvcMethod

public static boolean isMvcMethod(@Nonnull
                                  MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined MVC methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isMvcMethod(getMethod("mvcGroupInit"))    = true
 isMvcMethod(getMethod("mvcGroupDestroy")) = true
 isMvcMethod(getMethod("foo"))             = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an MVC method, false otherwise.

isThreadingMethod

public static boolean isThreadingMethod(@Nonnull
                                        Method method)

Finds out if the given Method belongs to the set of predefined threading methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isThreadingMethod(getMethod("execOutsideUI"))    = true
 isThreadingMethod(getMethod("doLater"))          = true
 isThreadingMethod(getMethod("foo"))              = false

Parameters:: method - a Method reference
Returns:: true if the method is a threading method, false otherwise.

isThreadingMethod

public static boolean isThreadingMethod(@Nonnull
                                        MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined threading methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isThreadingMethod(getMethod("execOutsideUI"))    = true
 isThreadingMethod(getMethod("doLater"))          = true
 isThreadingMethod(getMethod("foo"))              = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is a threading method, false otherwise.

isEventPublisherMethod

public static boolean isEventPublisherMethod(@Nonnull
                                             Method method)

Finds out if the given Method belongs to the set of predefined event publisher methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isEventPublisherMethod(getMethod("addEventPublisher"))  = true
 isEventPublisherMethod(getMethod("publishEvent"))       = true
 isEventPublisherMethod(getMethod("foo"))                = false

Parameters:: method - a Method reference
Returns:: true if the method is an @EventPublisher method, false otherwise.

isEventPublisherMethod

public static boolean isEventPublisherMethod(@Nonnull
                                             MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined event publisher methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isEventPublisherMethod(getMethod("addEventPublisher"))  = true
 isEventPublisherMethod(getMethod("publishEvent"))       = true
 isEventPublisherMethod(getMethod("foo"))                = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an @EventPublisher method, false otherwise.

isObservableMethod

public static boolean isObservableMethod(@Nonnull
                                         Method method)

Finds out if the given Method belongs to the set of predefined observable methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isObservableMethod(getMethod("addPropertyChangeListener"))  = true
 isObservableMethod(getMethod("getPropertyChangeListeners")) = true
 isObservableMethod(getMethod("foo"))                        = false

Parameters:: method - a Method reference
Returns:: true if the method is an Observable method, false otherwise.

isObservableMethod

public static boolean isObservableMethod(@Nonnull
                                         MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined observable methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isObservableMethod(getMethod("addPropertyChangeListener"))  = true
 isObservableMethod(getMethod("getPropertyChangeListeners")) = true
 isObservableMethod(getMethod("foo"))                        = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an Observable method, false otherwise.

isResourceHandlerMethod

public static boolean isResourceHandlerMethod(@Nonnull
                                              Method method)

Finds out if the given Method belongs to the set of predefined resources methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isResourceHandlerMethod(getMethod("getResourceAsURL"))    = true
 isResourceHandlerMethod(getMethod("getResourceAsStream")) = true
 isResourceHandlerMethod(getMethod("foo"))                 = false

Parameters:: method - a Method reference
Returns:: true if the method is an Observable method, false otherwise.

isResourceHandlerMethod

public static boolean isResourceHandlerMethod(@Nonnull
                                              MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined resources methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isResourceHandlerMethod(getMethod("getResourceAsURL"))    = true
 isResourceHandlerMethod(getMethod("getResourceAsStream")) = true
 isResourceHandlerMethod(getMethod("foo"))                 = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an Observable method, false otherwise.

isMessageSourceMethod

public static boolean isMessageSourceMethod(@Nonnull
                                            Method method)

Finds out if the given Method belongs to the set of predefined message source methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isMessageSourceMethod(getMethod("getMessage"))    = true
 isMessageSourceMethod(getMethod("foo"))           = false

Parameters:: method - a Method reference
Returns:: true if the method is an Observable method, false otherwise.

isMessageSourceMethod

public static boolean isMessageSourceMethod(@Nonnull
                                            MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined message source methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isMessageSourceMethod(getMethod("getMessage"))    = true
 isMessageSourceMethod(getMethod("foo"))           = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an Observable method, false otherwise.

isResourceResolverMethod

public static boolean isResourceResolverMethod(@Nonnull
                                               Method method)

Finds out if the given Method belongs to the set of predefined resource resolver methods by convention.

 // assuming getMethod() returns an appropriate Method reference
 isResourceResolverMethod(getMethod("resolveResource")) = true
 isResourceResolverMethod(getMethod("foo"))             = false

Parameters:: method - a Method reference
Returns:: true if the method is an Observable method, false otherwise.

isResourceResolverMethod

public static boolean isResourceResolverMethod(@Nonnull
                                               MethodDescriptor method)

Finds out if the given MethodDescriptor belongs to the set of predefined resource resolver methods by convention.

 // assuming getMethod() returns an appropriate MethodDescriptor reference
 isResourceResolverMethod(getMethod("resolveResource")) = true
 isResourceResolverMethod(getMethod("foo"))             = false

Parameters:: method - a MethodDescriptor reference
Returns:: true if the method is an Observable method, false otherwise.

isInstanceMethod
```
public static boolean isInstanceMethod(@Nonnull
                                       Method method)
```
Finds out if the given Method is an instance method, i.e, it is public and non-static.

Parameters:

method - a Method reference

Returns:

true if the method is an instance method, false otherwise.

isInstanceMethod
```
public static boolean isInstanceMethod(@Nonnull
                                       MethodDescriptor method)
```
Finds out if the given MethodDescriptor is an instance method, i.e, it is public and non-static.

Parameters:

method - a MethodDescriptor reference

Returns:

true if the method is an instance method, false otherwise.

isPlainMethod
```
public static boolean isPlainMethod(@Nonnull
                                    Method method)
```
Finds out if the given Method matches the following criteria:
- isInstanceMethod(method)
- ! isBasicMethod(method)
- ! isGroovyInjectedMethod(method)
- ! isThreadingMethod(method)
- ! isArtifactMethod(method)
- ! isMvcMethod(method)
- ! isServiceMethod(method)
- ! isEventPublisherMethod(method)
- ! isObservableMethod(method)
- ! isResourceHandlerMethod(method)
- ! isGetterMethod(method)
- ! isSetterMethod(method)
- ! isContributionMethod(method)
Parameters:

method - a Method reference

Returns:

true if the method matches the given criteria, false otherwise.

isPlainMethod
```
public static boolean isPlainMethod(@Nonnull
                                    MethodDescriptor method)
```
Finds out if the given MethodDescriptor matches the following criteria:
- isInstanceMethod(method)
- ! isBasicMethod(method)
- ! isGroovyInjectedMethod(method)
- ! isThreadingMethod(method)
- ! isArtifactMethod(method)
- ! isMvcMethod(method)
- ! isServiceMethod(method)
- ! isEventPublisherMethod(method)
- ! isObservableMethod(method)
- ! isResourceHandlerMethod(method)
- ! isGetterMethod(method)
- ! isSetterMethod(method)
- ! isContributionMethod(method)
Parameters:

method - a MethodDescriptor reference

Returns:

true if the method matches the given criteria, false otherwise.

isPropertyOfType

public static boolean isPropertyOfType(Class<?> clazz,
                                       String propertyName,
                                       Class<?> type)

Returns true if the specified property in the specified class is of the specified type

Parameters:: clazz - The class which contains the property; propertyName - The property name; type - The type to check
Returns:: A boolean value

instantiateClass
```
@Nonnull
public static Object instantiateClass(@Nonnull
                                               Class<?> clazz)
```
Instantiates a Class, wrapping any exceptions in a RuntimeException.

Parameters:

clazz - target Class for which an object will be instantiated

Returns:

the newly instantiated object.

Throws:

BeanInstantiationException - if an error occurs when creating the object

instantiate

@Nonnull
public static Object instantiate(@Nonnull
                                          Class<?> clazz,
                                          @Nullable
                                          Object[] args)

getPropertyValueOfNewInstance

@Nullable
public static Object getPropertyValueOfNewInstance(@Nullable
                                                             Class<?> clazz,
                                                             @Nullable
                                                             String propertyName,
                                                             Class<?> propertyType)

Returns the value of the specified property and type from an instance of the specified Griffon class

Parameters:: clazz - The name of the class which contains the property; propertyName - The property name; propertyType - The property type
Returns:: The value of the property or null if none exists

getPropertyValueOfNewInstance
```
public static Object getPropertyValueOfNewInstance(Class<?> clazz,
                                                   String propertyName)
```
Returns the value of the specified property and type from an instance of the specified Griffon class

Parameters:

clazz - The name of the class which contains the property

propertyName - The property name

Returns:

The value of the property or null if none exists

getPropertyDescriptorForValue

public static PropertyDescriptor getPropertyDescriptorForValue(Object instance,
                                                               Object propertyValue)

Retrieves a PropertyDescriptor for the specified instance and property value

Parameters:: instance - The instance; propertyValue - The value of the property
Returns:: The PropertyDescriptor

getPropertyType

@Nullable
public static Class<?> getPropertyType(@Nullable
                                                 Class<?> clazz,
                                                 @Nullable
                                                 String propertyName)

Returns the type of the given property contained within the specified class

Parameters:: clazz - The class which contains the property; propertyName - The name of the property
Returns:: The property type or null if none exists

getPropertiesOfType

@Nonnull
public static PropertyDescriptor[] getPropertiesOfType(@Nullable
                                                                Class<?> clazz,
                                                                @Nullable
                                                                Class<?> propertyType)

Retrieves all the properties of the given class for the given type

Parameters:: clazz - The class to retrieve the properties from; propertyType - The type of the properties you wish to retrieve
Returns:: An array of PropertyDescriptor instances

getPropertiesAssignableToType
```
public static PropertyDescriptor[] getPropertiesAssignableToType(Class<?> clazz,
                                                                 Class<?> propertySuperType)
```
Retrieves all the properties of the given class which are assignable to the given type

Parameters:

clazz - The class to retrieve the properties from

propertySuperType - The type of the properties you wish to retrieve

Returns:

An array of PropertyDescriptor instances

getProperty

public static PropertyDescriptor getProperty(Class<?> clazz,
                                             String propertyName,
                                             Class<?> propertyType)

Retrieves a property of the given class of the specified name and type

Parameters:: clazz - The class to retrieve the property from; propertyName - The name of the property; propertyType - The type of the property
Returns:: A PropertyDescriptor instance or null if none exists

collectionToObjectArray
```
public static Object[] collectionToObjectArray(Collection<?> c)
```
Convenience method for converting a collection to an Object[]

Parameters:

c - The collection

Returns:

An object array

isMatchBetweenPrimitiveAndWrapperTypes

public static boolean isMatchBetweenPrimitiveAndWrapperTypes(@Nonnull
                                                             Class<?> leftType,
                                                             @Nonnull
                                                             Class<?> rightType)

Detect if left and right types are matching types. In particular, test if one is a primitive type and the other is the corresponding Java wrapper type. Primitive and wrapper classes may be passed to either arguments.

Parameters:: leftType -; rightType -
Returns:: true if one of the classes is a native type and the other the object representation of the same native type

isMatchBetweenPrimitiveAndWrapperTypes

public static boolean isMatchBetweenPrimitiveAndWrapperTypes(@Nonnull
                                                             String leftType,
                                                             @Nonnull
                                                             String rightType)

Parameters:: leftType -; rightType -
Returns:: true if one of the classes is a native type and the other the object representation of the same native type

isStaticProperty
```
public static boolean isStaticProperty(@Nonnull
                                       Class<?> clazz,
                                       @Nonnull
                                       String propertyName)
```
Work out if the specified property is readable and static. Java introspection does not recognize this concept of static properties but Groovy does. We also consider public static fields as static properties with no getters/setters

Parameters:

clazz - The class to check for static property

propertyName - The property name

Returns:

true if the property with name propertyName has a static getter method

isPublicStatic
```
public static boolean isPublicStatic(@Nonnull
                                     Method m)
```
Determine whether the method is declared public static

Parameters:

m - the method to be tested

Returns:

True if the method is declared public static

isPublicStatic
```
public static boolean isPublicStatic(@Nonnull
                                     Field f)
```
Determine whether the field is declared public static

Parameters:

f - the field to be tested

Returns:

True if the field is declared public static

getGetterName
```
@Nonnull
public static String getGetterName(@Nonnull
                                            String propertyName)
```
Calculate the name for a getter method to retrieve the specified property

Parameters:

propertyName - the name of the property

Returns:

The name for the getter method for this property, if it were to exist, i.e. getConstraints

getStaticPropertyValue

@Nullable
public static Object getStaticPropertyValue(@Nonnull
                                                      Class<?> clazz,
                                                      @Nonnull
                                                      String name)

Get a static property value, which has a public static getter or is just a public static field.

Parameters:: clazz - The class to check for static property; name - The property name
Returns:: The value if there is one, or null if unset OR there is no such property

getPropertyOrStaticPropertyOrFieldValue

@Nullable
public static Object getPropertyOrStaticPropertyOrFieldValue(@Nonnull
                                                                       Object obj,
                                                                       @Nonnull
                                                                       String name)

Looks for a property of the reference instance with a given name.

If found its value is returned. We follow the Java bean conventions with augmentation for groovy support and static fields/properties. We will therefore match, in this order:

Standard public bean property (with getter or just public field, using normal introspection)
Public static property with getter method
Public static field

Returns:: property value or null if no property found

getFieldValue

@Nullable
public static Object getFieldValue(@Nonnull
                                             Object obj,
                                             @Nonnull
                                             String name)

Get the value of a declared field on an object

Parameters:: obj - the instance that owns the field; name - the name of the file to lookup
Returns:: The object value or null if there is no such field or access problems

getField

@Nullable
public static Field getField(@Nonnull
                                       Object obj,
                                       @Nonnull
                                       String name)

Get the a declared field on an object

Parameters:: obj - the instance that owns the field; name - the name of the file to lookup
Returns:: The field or null if there is no such field or access problems

getField

@Nullable
public static Field getField(@Nonnull
                                       Class<?> clazz,
                                       @Nonnull
                                       String name)

Get the a declared field on a class

Parameters:: clazz - the clazz that owns the field; name - the name of the file to lookup
Returns:: The field or null if there is no such field or access problems

isPublicField

public static boolean isPublicField(@Nonnull
                                    Object obj,
                                    @Nonnull
                                    String name)

Work out if the specified object has a public field with the name supplied.

Parameters:: obj - the instance that owns the field; name - the name of the file to lookup
Returns:: True if a public field with the name exists

isPropertyInherited

public static boolean isPropertyInherited(@Nullable
                                          Class<?> clz,
                                          @Nonnull
                                          String propertyName)

Checks whether the specified property is inherited from a super class

Parameters:: clz - The class to check; propertyName - The property name
Returns:: True if the property is inherited

createConcreteCollection

@Nonnull
public static Collection<?> createConcreteCollection(@Nonnull
                                                              Class<?> interfaceType)

Creates a concrete collection for the supplied interface

Parameters:: interfaceType - The interface
Returns:: ArrayList for List, TreeSet for SortedSet, HashSet for Set etc.

getSetterName

@Nonnull
public static String getSetterName(@Nonnull
                                            String propertyName)

Retrieves the name of a setter for the specified property name

Parameters:: propertyName - The property name
Returns:: The setter equivalent

isGetter

public static boolean isGetter(@Nullable
                               String name,
                               @Nullable
                               Class[] args)

Returns true if the name of the method specified and the number of arguments make it a javabean property

Parameters:: name - True if its a Javabean property; args - The arguments
Returns:: True if it is a javabean property method

getPropertyForGetter

@Nullable
public static String getPropertyForGetter(@Nullable
                                                    String getterName)

Returns a property name equivalent for the given getter name or null if it is not a getter

Parameters:: getterName - The getter name
Returns:: The property name equivalent

getPropertyForSetter

@Nullable
public static String getPropertyForSetter(@Nullable
                                                    String setterName)

Returns a property name equivalent for the given setter name or null if it is not a getter

Parameters:: setterName - The setter name
Returns:: The property name equivalent

isSetter

public static boolean isSetter(@Nullable
                               String name,
                               @Nullable
                               Class[] args)

isAssignableOrConvertibleFrom

public static boolean isAssignableOrConvertibleFrom(@Nullable
                                                    Class<?> clazz,
                                                    @Nullable
                                                    Class<?> type)

Returns true if the specified clazz parameter is either the same as, or is a superclass or super interface of, the specified type parameter. Converts primitive types to compatible class automatically.

Parameters:: clazz -; type -
Returns:: True if the class is a taglib
See Also:: Class.isAssignableFrom(Class)

getBooleanFromMap

public static boolean getBooleanFromMap(@Nullable
                                        String key,
                                        @Nullable
                                        Map<String,Object> map)

Retrieves a boolean value from a Map for the given key

Parameters:: key - The key that references the boolean value; map - The map to look in
Returns:: A boolean value which will be false if the map is null, the map doesn't contain the key or the value is false

isClassBelowPackage

public static boolean isClassBelowPackage(@Nonnull
                                          Class<?> clazz,
                                          @Nonnull
                                          List<?> packageList)

Returns whether the specified class is either within one of the specified packages or within a subpackage of one of the packages

Parameters:: clazz - The class; packageList - The list of packages
Returns:: True if it is within the list of specified packages

setPropertiesOrFields

public static void setPropertiesOrFields(@Nonnull
                                         Object bean,
                                         @Nonnull
                                         Map<String,Object> properties)
                                  throws PropertyException

Sets or updates an object's properties.

This method will attempt setting a property using a matching PropertyDescriptor; next it will try direct field access if the property was not found.

Parameters:: bean - the target object on which properties will be set; properties - names and values for properties to be set
Throws:: PropertyException - if a property could be found
Since:: 2.1.0

setPropertiesOrFieldsNoException

public static void setPropertiesOrFieldsNoException(@Nonnull
                                                    Object bean,
                                                    @Nonnull
                                                    Map<String,Object> properties)

Sets or updates an object's properties.

This method will attempt setting a property using a matching PropertyDescriptor; next it will try direct field access if the property was not found.

Parameters:: bean - the target object on which properties will be set; properties - names and values for properties to be set
Since:: 2.1.0

setPropertyOrFieldValue

public static void setPropertyOrFieldValue(@Nonnull
                                           Object bean,
                                           @Nonnull
                                           String name,
                                           @Nullable
                                           Object value)
                                    throws PropertyException

Sets or updates an object's property.

This method will attempt setting a property using a matching PropertyDescriptor; next it will try direct field access if the property was not found.

Parameters:: bean - the target object on which the property will be set; name - the name of the property to set; value - the value to be set
Throws:: PropertyException - if the property could not be found
Since:: 2.1.0

setFieldsOrProperties

public static void setFieldsOrProperties(@Nonnull
                                         Object bean,
                                         @Nonnull
                                         Map<String,Object> properties)
                                  throws FieldException

Sets or updates an object's properties.

This method will attempt setting a property using direct field access; next it will try a PropertyDescriptor if a matching field name was not found.

Parameters:: bean - the target object on which properties will be set; properties - names and values for properties to be set
Throws:: FieldException - if the field could not be found
Since:: 2.1.0

setFieldsOrPropertiesNoException

public static void setFieldsOrPropertiesNoException(@Nonnull
                                                    Object bean,
                                                    @Nonnull
                                                    Map<String,Object> properties)

Sets or updates an object's properties.

This method will attempt setting a property using direct field access; next it will try a PropertyDescriptor if a matching field name was not found.

Parameters:: bean - the target object on which properties will be set; properties - names and values for properties to be set
Since:: 2.1.0

setFieldOrPropertyValue

public static void setFieldOrPropertyValue(@Nonnull
                                           Object bean,
                                           @Nonnull
                                           String name,
                                           @Nullable
                                           Object value)
                                    throws FieldException

Sets or updates an object's property.

This method will attempt setting a property using direct field access; next it will try a PropertyDescriptor if a matching field name was not found.

Parameters:: bean - the target object on which the property will be set; name - the name of the property to set; value - the value to be set
Throws:: FieldException - if the property could not be found
Since:: 2.1.0

setFields

public static void setFields(@Nonnull
                             Object bean,
                             @Nonnull
                             Map<String,Object> fields)
                      throws FieldException

Sets or updates field values on an object.

Parameters:: bean - the target object on which field values will be set; fields - names and values of fields to be set
Throws:: FieldException - if a field could not be found
Since:: 2.1.0

setFieldsNoException

public static void setFieldsNoException(@Nonnull
                                        Object bean,
                                        @Nonnull
                                        Map<String,Object> fields)

Sets or updates field values on an object.

Parameters:: bean - the target object on which field values will be set; fields - names and values of fields to be set
Since:: 2.1.0

setFieldValue

public static void setFieldValue(@Nonnull
                                 Object bean,
                                 @Nonnull
                                 String name,
                                 @Nullable
                                 Object value)
                          throws FieldException

Sets or updates an object's field.

Parameters:: bean - the target object on which the field will be set; name - the name of the field to set; value - the value to be set
Throws:: FieldException - if the field could not be found
Since:: 2.1.0

setProperties

public static void setProperties(@Nonnull
                                 Object bean,
                                 @Nonnull
                                 Map<String,Object> properties)
                          throws PropertyException

Sets or updates properties on an object.

Parameters:: bean - the target object on which properties will be set; properties - names and values of properties to be set
Throws:: PropertyException - if a property could not be found

setPropertiesNoException

public static void setPropertiesNoException(@Nonnull
                                            Object bean,
                                            @Nonnull
                                            Map<String,Object> properties)

Sets or updates properties on an object.

Parameters:: bean - the target object on which properties will be set; properties - names and values of properties to be set

setPropertyValue

public static void setPropertyValue(@Nonnull
                                    Object bean,
                                    @Nonnull
                                    String name,
                                    @Nullable
                                    Object value)
                             throws PropertyException

/** Sets or updates a property on an object.

Parameters:: bean - the target object on which the property will be set; name - the name of the property to set; value - the value to be set
Throws:: PropertyException - if the property could not be found

getPropertyValue

@Nullable
public static Object getPropertyValue(@Nonnull
                                                Object bean,
                                                @Nonnull
                                                String name)
                                         throws PropertyException

Returns the value of a property.

Parameters:: bean - the owner of the property; name - the name of the property to retrieve
Returns:: the value read from the matching property
Throws:: PropertyException - if the property could not be found

getPropertyDescriptor

@Nullable
public static PropertyDescriptor getPropertyDescriptor(@Nonnull
                                                                 Object bean,
                                                                 @Nonnull
                                                                 String name)
                                                          throws IllegalAccessException,
                                                                 InvocationTargetException,
                                                                 NoSuchMethodException

Retrieve the property descriptor for the specified property of the specified bean, or return null if there is no such descriptor.

This method does not resolve index, nested nor mapped properties.

Parameters:: bean - Bean for which a property descriptor is requested; name - name of the property for which a property descriptor is requested
Returns:: the property descriptor or null if the bean does not have a property that matches the specified name.
Throws:: IllegalAccessException - if the caller does not have access to the property accessor method; IllegalArgumentException - if bean or name is null; InvocationTargetException - if the property accessor method throws an exception; NoSuchMethodException - if an accessor method for this property cannot be found

getPropertyDescriptor

@Nullable
public static PropertyDescriptor getPropertyDescriptor(@Nonnull
                                                                 Class<?> clazz,
                                                                 @Nonnull
                                                                 String name)
                                                          throws IllegalAccessException,
                                                                 InvocationTargetException,
                                                                 NoSuchMethodException

Retrieve the property descriptor for the specified property of the specified class, or return null if there is no such descriptor.

This method does not resolve index, nested nor mapped properties.

Parameters:: clazz - class for which a property descriptor is requested; name - name of the property for which a property descriptor is requested
Returns:: the property descriptor or null if the bean does not have a property that matches the specified name.
Throws:: IllegalAccessException - if the caller does not have access to the property accessor method; IllegalArgumentException - if bean or name is null; InvocationTargetException - if the property accessor method throws an exception; NoSuchMethodException - if an accessor method for this property cannot be found

getPropertyDescriptors
```
@Nonnull
public static PropertyDescriptor[] getPropertyDescriptors(@Nonnull
                                                                   Class<?> beanClass)
```
Retrieve the property descriptors for the specified class, introspecting and caching them the first time a particular bean class is encountered.

Parameters:

beanClass - Bean class for which property descriptors are requested

Returns:

the property descriptors

Throws:

IllegalArgumentException - if beanClass is null

getReadMethod
```
@Nullable
public static Method getReadMethod(@Nonnull
                                             PropertyDescriptor descriptor)
```
Return an accessible property getter method for this property, if there is one; otherwise return null.

Parameters:

descriptor - Property descriptor to return a getter for

Returns:

The read method

isReadable
```
public static boolean isReadable(@Nonnull
                                 Object bean,
                                 @Nonnull
                                 String name)
```
Return true if the specified property name identifies a readable property on the specified bean; otherwise, return false.

Parameters:

bean - Bean to be examined

name - Property name to be evaluated

Returns:

true if the property is readable, otherwise false

Throws:

IllegalArgumentException - if bean or name is null

Since:

BeanUtils 1.6

getWriteMethod
```
@Nullable
public static Method getWriteMethod(@Nonnull
                                              PropertyDescriptor descriptor)
```
Return an accessible property setter method for this property, if there is one; otherwise return null.

Parameters:

descriptor - Property descriptor to return a setter for

Returns:

The write method

isWritable
```
public static boolean isWritable(@Nonnull
                                 Object bean,
                                 @Nonnull
                                 String name)
```
Return true if the specified property name identifies a writable property on the specified bean; otherwise, return false.

Parameters:

bean - Bean to be examined

name - Property name to be evaluated

Returns:

true if the property is writable, otherwise false

Throws:

IllegalArgumentException - if bean or name is null

setField

public static void setField(@Nonnull
                            Object bean,
                            @Nonnull
                            String name,
                            @Nullable
                            Object value)
                     throws NoSuchFieldException,
                            IllegalAccessException,
                            FieldException

Sets the value of the specified field of the specified bean.

Parameters:: bean - Bean whose field is to be mutated; name - Name of the field to be mutated; value - The value to be set on the property
Throws:: IllegalAccessException - if the caller does not have access to the field; IllegalArgumentException - if bean or name is null; NoSuchFieldException - if the named field cannot be found; FieldException - if the field cannot be set
Since:: 2.1.0

setProperty

public static void setProperty(@Nonnull
                               Object bean,
                               @Nonnull
                               String name,
                               @Nullable
                               Object value)
                        throws IllegalAccessException,
                               InvocationTargetException,
                               NoSuchMethodException,
                               PropertyException

Sets the value of the specified property of the specified bean.

Parameters:: bean - Bean whose property is to be mutated; name - Name of the property to be mutated; value - The value to be set on the property
Throws:: IllegalAccessException - if the caller does not have access to the property accessor method; IllegalArgumentException - if bean or name is null; InvocationTargetException - if the property accessor method throws an exception; NoSuchMethodException - if an accessor method for this property cannot be found; PropertyException - if the property cannot be set

getProperty
```
@Nullable
public static Object getProperty(@Nonnull
                                           Object bean,
                                           @Nonnull
                                           String name)
                                    throws IllegalAccessException,
                                           InvocationTargetException,
                                           NoSuchMethodException
```
Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.

Parameters:

bean - Bean whose property is to be extracted

name - Possibly indexed and/or nested name of the property to be extracted

Returns:

the property value

Throws:

IllegalAccessException - if the caller does not have access to the property accessor method

IllegalArgumentException - if bean or name is null

InvocationTargetException - if the property accessor method throws an exception

NoSuchMethodException - if an accessor method for this property cannot be found

getReadMethod

@Nullable
public static Method getReadMethod(@Nonnull
                                             Class<?> clazz,
                                             @Nonnull
                                             PropertyDescriptor descriptor)

Return an accessible property getter method for this property, if there is one; otherwise return null.

Parameters:: clazz - The class of the read method will be invoked on; descriptor - Property descriptor to return a getter for
Returns:: The read method

getWriteMethod

@Nullable
public static Method getWriteMethod(@Nonnull
                                              Class<?> clazz,
                                              @Nonnull
                                              PropertyDescriptor descriptor)

Return an accessible property setter method for this property, if there is one; otherwise return null.

Parameters:: clazz - The class of the write method will be invoked on; descriptor - Property descriptor to return a setter for
Returns:: The write method

isTrue
```
public static void isTrue(boolean expression,
                          String message)
```
Validate that the argument condition is true; otherwise throwing an exception with the specified message. This method is useful when validating according to an arbitrary boolean expression, such as validating a primitive number or using your own custom validation expression.
```
 isTrue( (i > 0), "The value must be greater than zero");
 isTrue( myObject.isOk(), "The object is not OK");
 
```
Parameters:

expression - the boolean expression to check

message - the exception message if invalid

Throws:

IllegalArgumentException - if expression is false

invokeInstanceMethod

@Nullable
public static Object invokeInstanceMethod(@Nonnull
                                                    Object object,
                                                    @Nonnull
                                                    String methodName)

invokeInstanceMethod

@Nullable
public static Object invokeInstanceMethod(@Nonnull
                                                    Object object,
                                                    @Nonnull
                                                    String methodName,
                                                    Object arg)

invokeInstanceMethod

@Nullable
public static Object invokeInstanceMethod(@Nonnull
                                                    Object object,
                                                    @Nonnull
                                                    String methodName,
                                                    Object... args)

invokeExactInstanceMethod

@Nullable
public static Object invokeExactInstanceMethod(@Nonnull
                                                         Object object,
                                                         @Nonnull
                                                         String methodName)

invokeExactInstanceMethod

@Nullable
public static Object invokeExactInstanceMethod(@Nonnull
                                                         Object object,
                                                         @Nonnull
                                                         String methodName,
                                                         Object arg)

invokeExactInstanceMethod

@Nullable
public static Object invokeExactInstanceMethod(@Nonnull
                                                         Object object,
                                                         @Nonnull
                                                         String methodName,
                                                         Object... args)

invokeStaticMethod

@Nullable
public static Object invokeStaticMethod(@Nonnull
                                                  Class<?> type,
                                                  @Nonnull
                                                  String methodName)

invokeStaticMethod

@Nullable
public static Object invokeStaticMethod(@Nonnull
                                                  Class<?> type,
                                                  @Nonnull
                                                  String methodName,
                                                  Object arg)

invokeStaticMethod

@Nullable
public static Object invokeStaticMethod(@Nonnull
                                                  Class<?> type,
                                                  @Nonnull
                                                  String methodName,
                                                  Object... args)

invokeExactStaticMethod

@Nullable
public static Object invokeExactStaticMethod(@Nonnull
                                                       Class<?> type,
                                                       @Nonnull
                                                       String methodName)

invokeExactStaticMethod

@Nullable
public static Object invokeExactStaticMethod(@Nonnull
                                                       Class<?> type,
                                                       @Nonnull
                                                       String methodName,
                                                       Object arg)

invokeExactStaticMethod

@Nullable
public static Object invokeExactStaticMethod(@Nonnull
                                                       Class<?> type,
                                                       @Nonnull
                                                       String methodName,
                                                       Object... args)

getShortClassName

@Nonnull
public static String getShortClassName(@Nullable
                                                Object object,
                                                @Nonnull
                                                String valueIfNull)

Gets the class name minus the package name for an Object.

Parameters:: object - the class to get the short name for, may be null; valueIfNull - the value to return if null
Returns:: the class name of the object without the package name, or the null value

getShortClassName
```
@Nonnull
public static String getShortClassName(@Nullable
                                                Class<?> cls)
```
Gets the class name minus the package name from a Class.

Parameters:

cls - the class to get the short name for.

Returns:

the class name without the package name or an empty string

getShortClassName
```
@Nonnull
public static String getShortClassName(@Nullable
                                                String className)
```
Gets the class name minus the package name from a String.

The string passed in is assumed to be a class name - it is not checked.

Parameters:

className - the className to get the short name for

Returns:

the class name of the class without the package name or an empty string

getPackageName

@Nonnull
public static String getPackageName(@Nullable
                                             Object object,
                                             @Nonnull
                                             String valueIfNull)

Gets the package name of an Object.

Parameters:: object - the class to get the package name for, may be null; valueIfNull - the value to return if null
Returns:: the package name of the object, or the null value

getPackageName

@Nonnull
public static String getPackageName(@Nullable
                                             Class<?> cls)

Gets the package name of a Class.

Parameters:: cls - the class to get the package name for, may be null.
Returns:: the package name or an empty string

getPackageName
```
@Nonnull
public static String getPackageName(@Nullable
                                             String className)
```
Gets the package name from a String.

The string passed in is assumed to be a class name - it is not checked.

If the class is unpackaged, return an empty string.

Parameters:

className - the className to get the package name for, may be null

Returns:

the package name or an empty string

convertToTypeArray

@Nullable
public static Class<?>[] convertToTypeArray(@Nullable
                                                      Object[] args)

param instance array to the type array

Parameters:: args - the arguments
Returns:: the types of the arguments

Class GriffonClassUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_CLASS_ARRAY

EMPTY_OBJECT_ARRAY

EMPTY_ARGS

PRIMITIVE_TYPE_COMPATIBLE_CLASSES

PRIMITIVE_TYPE_COMPATIBLE_TYPES

PACKAGE_SEPARATOR_CHAR

PACKAGE_SEPARATOR

INNER_CLASS_SEPARATOR_CHAR

INNER_CLASS_SEPARATOR

Constructor Detail

GriffonClassUtils

Method Detail

requireState

requireState

isEventHandler

isEventHandler

isEventHandler

isBasicMethod

isContributionMethod

isContributionMethod

isContributionMethod

isBasicMethod

isGroovyInjectedMethod

isGroovyInjectedMethod

isGetterMethod

isGetterMethod

isSetterMethod

isSetterMethod

isArtifactMethod

isArtifactMethod

isMvcMethod

isMvcMethod

isThreadingMethod

isThreadingMethod

isEventPublisherMethod

isEventPublisherMethod

isObservableMethod

isObservableMethod

isResourceHandlerMethod

isResourceHandlerMethod

isMessageSourceMethod

isMessageSourceMethod

isResourceResolverMethod

isResourceResolverMethod

isInstanceMethod

isInstanceMethod

isPlainMethod

isPlainMethod

isPropertyOfType

instantiateClass

instantiate

getPropertyValueOfNewInstance

getPropertyValueOfNewInstance

getPropertyDescriptorForValue

getPropertyType

getPropertiesOfType

getPropertiesAssignableToType

getProperty

collectionToObjectArray

isMatchBetweenPrimitiveAndWrapperTypes

isMatchBetweenPrimitiveAndWrapperTypes

isStaticProperty

isPublicStatic

isPublicStatic

getGetterName

getStaticPropertyValue

getPropertyOrStaticPropertyOrFieldValue

getFieldValue

getField

getField

isPublicField

isPropertyInherited

createConcreteCollection

getSetterName