Package grails.util

Class GrailsClassUtils

java.lang.Object
grails.util.GrailsClassUtils
public final class GrailsClassUtils extends Object
Utility methods for dealing with Grails class artifacts.

  • Field Details

    • PRIMITIVE_TYPE_COMPATIBLE_CLASSES

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

  • Method Details

    • getAllInterfaces

      public static Class[] getAllInterfaces(Object instance)
      Return all interfaces that the given instance implements as array, including ones implemented by superclasses.
      Parameters:
      instance - the instance to analyze for interfaces
      Returns:
      all interfaces that the given instance implements as array

    • getAllInterfacesForClass

      public static Class<?>[] getAllInterfacesForClass(Class<?> clazz)
      Return all interfaces that the given class implements as array, including ones implemented by superclasses.

      If the class itself is an interface, it gets returned as sole interface.

      Parameters:
      clazz - the class to analyze for interfaces
      Returns:
      all interfaces that the given object implements as array

    • getAllInterfacesForClass

      public static Class<?>[] getAllInterfacesForClass(Class<?> clazz, ClassLoader classLoader)
      Return all interfaces that the given class implements as array, including ones implemented by superclasses.

      If the class itself is an interface, it gets returned as sole interface.

      Parameters:
      clazz - the class to analyze for interfaces
      classLoader - the ClassLoader that the interfaces need to be visible in (may be null when accepting all declared interfaces)
      Returns:
      all interfaces that the given object implements as array

    • getAllInterfacesAsSet

      public static Set<Class> getAllInterfacesAsSet(Object instance)
      Return all interfaces that the given instance implements as Set, including ones implemented by superclasses.
      Parameters:
      instance - the instance to analyze for interfaces
      Returns:
      all interfaces that the given instance implements as Set

    • getAllInterfacesForClassAsSet

      public static Set<Class> getAllInterfacesForClassAsSet(Class clazz)
      Return all interfaces that the given class implements as Set, including ones implemented by superclasses.

      If the class itself is an interface, it gets returned as sole interface.

      Parameters:
      clazz - the class to analyze for interfaces
      Returns:
      all interfaces that the given object implements as Set

    • getAllInterfacesForClassAsSet

      public static Set<Class> getAllInterfacesForClassAsSet(Class clazz, ClassLoader classLoader)
      Return all interfaces that the given class implements as Set, including ones implemented by superclasses.

      If the class itself is an interface, it gets returned as sole interface.

      Parameters:
      clazz - the class to analyze for interfaces
      classLoader - the ClassLoader that the interfaces need to be visible in (may be null when accepting all declared interfaces)
      Returns:
      all interfaces that the given object implements as Set

    • isVisible

      public static boolean isVisible(Class<?> clazz, ClassLoader classLoader)
      Check whether the given class is visible in the given ClassLoader.
      Parameters:
      clazz - the class to check (typically an interface)
      classLoader - the ClassLoader to check against (may be null, in which case this method will always return true)

    • 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

    • getPropertyValueOfNewInstance

      public static Object getPropertyValueOfNewInstance(Class clazz, String propertyName, Class<?> propertyType)
      Returns the value of the specified property and type from an instance of the specified Grails 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 Grails 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

      public static Class<?> getPropertyType(Class<?> clazz, 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

      public static PropertyDescriptor[] getPropertiesOfType(Class<?> clazz, 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

    • getProperty

      public static PropertyDescriptor getProperty(Class<?> clazz, String propertyName)
      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
      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

    • isMatchBetweenPrimativeAndWrapperTypes

      public static boolean isMatchBetweenPrimativeAndWrapperTypes(Class leftType, 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

    • isGroovyAssignableFrom

      public static boolean isGroovyAssignableFrom(Class<?> leftType, Class<?> rightType)

      Tests whether or not the left hand type is compatible with the right hand type in Groovy terms, i.e. can the left type be assigned a value of the right hand type in Groovy.

      This handles Java primitive type equivalence and uses isAssignableFrom for all other types, with a bit of magic for native types and polymorphism i.e. Number assigned an int. If either parameter is null an exception is thrown

      Parameters:
      leftType - The type of the left hand part of a notional assignment
      rightType - The type of the right hand part of a notional assignment
      Returns:
      true if values of the right hand type can be assigned in Groovy to variables of the left hand type.

    • isStaticProperty

      public static boolean isStaticProperty(Class clazz, 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(Method m)
      Determine whether the method is declared public static
      Parameters:
      m -
      Returns:
      true if the method is declared public static

    • isPublicStatic

      public static boolean isPublicStatic(Field f)
      Determine whether the field is declared public static
      Parameters:
      f -
      Returns:
      true if the field is declared public static

    • getGetterName

      public static String getGetterName(String propertyName)
      Calculate the name for a getter method to retrieve the specified property
      Parameters:
      propertyName -
      Returns:
      The name for the getter method for this property, if it were to exist, i.e. getConstraints

    • getStaticFieldValue

      public static Object getStaticFieldValue(Class<?> clazz, String name)

      Get a static field value.

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

    • getStaticPropertyValue

      public 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.

      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

      public static Object getPropertyOrStaticPropertyOrFieldValue(Object obj, String name) throws org.springframework.beans.BeansException

      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:

      1. Standard public bean property (with getter or just public field, using normal introspection)
      2. Public static property with getter method
      3. Public static field
      Returns:
      property value or null if no property found
      Throws:
      org.springframework.beans.BeansException

    • getPropertyOrStaticPropertyOrFieldValue

      public static Object getPropertyOrStaticPropertyOrFieldValue(org.springframework.beans.BeanWrapper ref, Object obj, String name)

    • getFieldValue

      public static Object getFieldValue(Object obj, String name)
      Get the value of a declared field on an object
      Parameters:
      obj -
      name -
      Returns:
      The object value or null if there is no such field or access problems

    • isPublicField

      public static boolean isPublicField(Object obj, String name)
      Work out if the specified object has a public field with the name supplied.
      Parameters:
      obj -
      name -
      Returns:
      true if a public field with the name exists

    • isPropertyInherited

      public static boolean isPropertyInherited(Class clz, 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

    • isPropertyGetter

      public static boolean isPropertyGetter(Method method)
      Check whether the specified method is a property getter
      Parameters:
      method - The method
      Returns:
      true if the method is a property getter

    • createConcreteCollection

      public static Collection createConcreteCollection(Class interfaceType)
      Creates a concrete collection for the suppied interface
      Parameters:
      interfaceType - The interface
      Returns:
      ArrayList for List, TreeSet for SortedSet, HashSet for Set etc.

    • isSetter

      public static boolean isSetter(String name, Class[] args)
      Returns true if the name of the method specified and the number of arguments make it a javabean property setter. The name is assumed to be a valid Java method name, that is not verified.
      Parameters:
      name - The name of the method
      args - The arguments
      Returns:
      true if it is a javabean property setter

    • getExpandoMetaClass

      public static groovy.lang.MetaClass getExpandoMetaClass(Class clazz)

    • isAssignableOrConvertibleFrom

      public static boolean isAssignableOrConvertibleFrom(Class<?> clazz, Class<?> type)
      Returns true if the specified clazz parameter is either the same as, or is a superclass or superinterface 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:

    • getBooleanFromMap

      public static boolean getBooleanFromMap(String key, Map<?,?> 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

    • getBooleanFromMap

      public static boolean getBooleanFromMap(String key, Map<?,?> map, boolean defaultValue)
      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

    • findPropertyNameForValue

      public static String findPropertyNameForValue(Object target, Object obj)
      Locates the name of a property for the given value on the target object using Groovy's meta APIs. Note that this method uses the reference so the incorrect result could be returned for two properties that refer to the same reference. Use with caution.
      Parameters:
      target - The target
      obj - The property value
      Returns:
      The property name or null

    • getSetterName

      public static String getSetterName(String propertyName)
      Retrieves the name of a setter for the specified property name
      Parameters:
      propertyName - The property name
      Returns:
      The setter equivalent

    • isGetter

      @Deprecated public static boolean isGetter(String name, Class<?>[] args)
      Deprecated.
      use isGetter(String, Class, Class[]) instead because this method has a defect for "is.." method with Boolean return types.
      Returns true if the name of the method specified and the number of arguments make it a javabean property getter. The name is assumed to be a valid Java method name, that is not verified.
      Parameters:
      name - The name of the method
      args - The arguments
      Returns:
      true if it is a javabean property getter

    • isGetter

      public static boolean isGetter(String name, Class returnType, Class<?>[] args)
      Returns true if the name of the method specified and the number of arguments make it a javabean property getter. The name is assumed to be a valid Java method name, that is not verified.
      Parameters:
      name - The name of the method
      returnType - The return type of the method
      args - The arguments
      Returns:
      true if it is a javabean property getter

    • getPropertyForGetter

      @Deprecated public static String getPropertyForGetter(String getterName)
      Deprecated.
      Use getPropertyForGetter(String, Class) instead because this method has a defect for "is.." method with Boolean return types.
      Returns a property name equivalent for the given getter name or null if it is not a valid getter. If not null or empty the getter name is assumed to be a valid identifier.
      Parameters:
      getterName - The getter name
      Returns:
      The property name equivalent

    • getPropertyForGetter

      public static String getPropertyForGetter(String getterName, Class returnType)
      Returns a property name equivalent for the given getter name and return type or null if it is not a valid getter. If not null or empty the getter name is assumed to be a valid identifier.
      Parameters:
      getterName - The getter name
      returnType - The type the method returns
      Returns:
      The property name equivalent

    • getPropertyForGetter

      public static String getPropertyForGetter(String getterName, String returnType)
      Returns a property name equivalent for the given getter name and return type or null if it is not a valid getter. If not null or empty the getter name is assumed to be a valid identifier.
      Parameters:
      getterName - The getter name
      returnType - The class name the method returns
      Returns:
      The property name equivalent

    • getPropertyForSetter

      public static String getPropertyForSetter(String setterName)
      Returns a property name equivalent for the given setter name or null if it is not a valid setter. If not null or empty the setter name is assumed to be a valid identifier.
      Parameters:
      setterName - The setter name, must be null or empty or a valid identifier name
      Returns:
      The property name equivalent

    • isClassBelowPackage

      public static boolean isClassBelowPackage(Class<?> theClass, 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:
      theClass - The class
      packageList - The list of packages
      Returns:
      true if it is within the list of specified packages

    • instantiateFromConfig

      public static Object instantiateFromConfig(groovy.util.ConfigObject config, String configKey, String defaultClassName) throws InstantiationException, IllegalAccessException, ClassNotFoundException, LinkageError, InvocationTargetException, NoSuchMethodException
      Throws:
      InstantiationException
      IllegalAccessException
      ClassNotFoundException
      LinkageError
      InvocationTargetException
      NoSuchMethodException

    • instantiateFromFlatConfig

      public static Object instantiateFromFlatConfig(Map<String,Object> flatConfig, String configKey, String defaultClassName) throws InstantiationException, IllegalAccessException, ClassNotFoundException, LinkageError, NoSuchMethodException, InvocationTargetException
      Throws:
      InstantiationException
      IllegalAccessException
      ClassNotFoundException
      LinkageError
      NoSuchMethodException
      InvocationTargetException