ClassPropertyFetcher (Grace Data

org.grails.datastore.mapping.reflect.ClassPropertyFetcher

```
@SuppressWarnings("rawtypes")
public class ClassPropertyFetcher
extends Object
```
Reads the properties of a class in an optimized manner avoiding exceptions.
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`static Set<String>`	`EXCLUDED_PROPERTIES`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addBeanProperty(List<PropertyDescriptor> propertyDescriptors, MetaProperty property)`
	`public static void`	`clearCache()` deprecated: Does nothing, no longer needed
	`public static PropertyDescriptor`	`createPropertyDescriptor(Class declaringClass, MetaProperty property)` Creates a PropertyDescriptor from a MetaBeanProperty
	`public static ClassPropertyFetcher`	`forClass(Class c)`
	`public Field`	`getDeclaredField(String name)`
	`public static Object`	`getInstancePropertyValue(Object instance, String name)`
	`public Class`	`getJavaClass()` Returns: The Java that this ClassPropertyFetcher was constructor for
	`public List<MetaProperty>`	`getMetaProperties()` Returns: The meta properties of this class
	`public List<PropertyDescriptor>`	`getPropertiesAssignableFromType(Class assignableType)`
	`public List<PropertyDescriptor>`	`getPropertiesAssignableToType(Class assignableType)`
	`public List<PropertyDescriptor>`	`getPropertiesOfType(Class javaClass)`
	`public PropertyDescriptor`	`getPropertyDescriptor(String name)`
	`public PropertyDescriptor[]`	`getPropertyDescriptors()` deprecated: Use getMetaProperties instead
	`public Class`	`getPropertyType(String name)`
	`public Class`	`getPropertyType(String name, boolean onlyInstanceProperties)`
	`public static Class<?>`	`getPropertyType(Class<?> cls, String propertyName)`
	`public Object`	`getPropertyValue(String name)`
	`public Object`	`getPropertyValue(Object instance, String name)`
`<T>`	`public T`	`getPropertyValue(String name, Class<T> c)`
	`public Object`	`getReference()` deprecated: will be removed in a future version of GORM
`<T>`	`public T`	`getStaticPropertyValue(String name, Class<T> c)`
`<T>`	`public static T`	`getStaticPropertyValue(Class clazz, String name, Class<T> requiredType)`
`<T>`	`public List<T>`	`getStaticPropertyValuesFromInheritanceHierarchy(String name, Class<T> c)` Get the list of property values for this static property from the whole inheritance hierarchy, starting from the most derived version of the property ending with the base class.
`<T>`	`public static List<T>`	`getStaticPropertyValuesFromInheritanceHierarchy(Class theClass, String name, Class<T> requiredTyped)` Get the list of property values for this static property from the whole inheritance hierarchy, starting from the most derived version of the property ending with the base class.
	`public boolean`	`isReadableProperty(String name)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final Set<String> EXCLUDED_PROPERTIES
- Method Detail
  - protected void addBeanProperty(List<PropertyDescriptor> propertyDescriptors, MetaProperty property)
  - @Deprecated
    public static void clearCache()
    
    deprecated:
    Does nothing, no longer needed
  - public static PropertyDescriptor createPropertyDescriptor(Class declaringClass, MetaProperty property)
    
    Creates a PropertyDescriptor from a MetaBeanProperty
    Parameters:
    property - The bean property
    Returns:
    The descriptor or null
  - public static ClassPropertyFetcher forClass(Class c)
  - public Field getDeclaredField(String name)
  - public static Object getInstancePropertyValue(Object instance, String name)
  - public Class getJavaClass()
    
    Returns:
    The Java that this ClassPropertyFetcher was constructor for
  - public List<MetaProperty> getMetaProperties()
    
    Returns:
    The meta properties of this class
  - @SuppressWarnings("unchecked")
    public List<PropertyDescriptor> getPropertiesAssignableFromType(Class assignableType)
  - @SuppressWarnings("unchecked")
    public List<PropertyDescriptor> getPropertiesAssignableToType(Class assignableType)
  - public List<PropertyDescriptor> getPropertiesOfType(Class javaClass)
  - public PropertyDescriptor getPropertyDescriptor(String name)
  - @Deprecated
    public PropertyDescriptor[] getPropertyDescriptors()
    
    deprecated:
    Use getMetaProperties instead
  - public Class getPropertyType(String name)
  - public Class getPropertyType(String name, boolean onlyInstanceProperties)
  - public static Class<?> getPropertyType(Class<?> cls, String propertyName)
  - public Object getPropertyValue(String name)
  - public Object getPropertyValue(Object instance, String name)
  - <T> public T getPropertyValue(String name, Class<T> c)
  - @Deprecated
    public Object getReference()
    
    deprecated:
    will be removed in a future version of GORM
  - <T> public T getStaticPropertyValue(String name, Class<T> c)
  - <T> public static T getStaticPropertyValue(Class clazz, String name, Class<T> requiredType)
  - <T> public List<T> getStaticPropertyValuesFromInheritanceHierarchy(String name, Class<T> c)
    
    Get the list of property values for this static property from the whole inheritance hierarchy, starting from the most derived version of the property ending with the base class. There are entries for each extant version of the property in turn, so if you have a 10-deep inheritance hierarchy, you may get 0+ values returned, one per class in the hierarchy that has the property declared (and of the correct type).
    Parameters:
    name - Name of the property.
    c - Required type of the property (including derived types)
    Type Parameters:
    T - Required type of the property.
    Returns:
    The list, with 0+ values (never null). Do not modify the returned list.
  - <T> public static List<T> getStaticPropertyValuesFromInheritanceHierarchy(Class theClass, String name, Class<T> requiredTyped)
    
    Get the list of property values for this static property from the whole inheritance hierarchy, starting from the most derived version of the property ending with the base class. There are entries for each extant version of the property in turn, so if you have a 10-deep inheritance hierarchy, you may get 0+ values returned, one per class in the hierarchy that has the property declared (and of the correct type).
    Parameters:
    name - Name of the property.
    requiredTyped - Required type of the property (including derived types)
    Type Parameters:
    T - Required type of the property.
    Returns:
    The list, with 0+ values (never null). Do not modify the returned list.
  - public boolean isReadableProperty(String name)

Summary:
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Java] Class ClassPropertyFetcher

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final Set<String> EXCLUDED_PROPERTIES

Method Detail

protected void addBeanProperty(List<PropertyDescriptor> propertyDescriptors, MetaProperty property)

@Deprecated
public static void clearCache()

public static PropertyDescriptor createPropertyDescriptor(Class declaringClass, MetaProperty property)

public static ClassPropertyFetcher forClass(Class c)

public Field getDeclaredField(String name)

public static Object getInstancePropertyValue(Object instance, String name)

public Class getJavaClass()

public List<MetaProperty> getMetaProperties()

@SuppressWarnings("unchecked")
public List<PropertyDescriptor> getPropertiesAssignableFromType(Class assignableType)

@SuppressWarnings("unchecked")
public List<PropertyDescriptor> getPropertiesAssignableToType(Class assignableType)

public List<PropertyDescriptor> getPropertiesOfType(Class javaClass)

public PropertyDescriptor getPropertyDescriptor(String name)

@Deprecated
public PropertyDescriptor[] getPropertyDescriptors()

public Class getPropertyType(String name)

public Class getPropertyType(String name, boolean onlyInstanceProperties)

public static Class<?> getPropertyType(Class<?> cls, String propertyName)

public Object getPropertyValue(String name)

public Object getPropertyValue(Object instance, String name)

<T> public T getPropertyValue(String name, Class<T> c)

@Deprecated
public Object getReference()

<T> public T getStaticPropertyValue(String name, Class<T> c)

<T> public static T getStaticPropertyValue(Class clazz, String name, Class<T> requiredType)

<T> public List<T> getStaticPropertyValuesFromInheritanceHierarchy(String name, Class<T> c)

<T> public static List<T> getStaticPropertyValuesFromInheritanceHierarchy(Class theClass, String name, Class<T> requiredTyped)

public boolean isReadableProperty(String name)

[Java] Class ClassPropertyFetcher

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final Set<String> EXCLUDED_PROPERTIES

Method Detail

protected void addBeanProperty(List<PropertyDescriptor> propertyDescriptors, MetaProperty property)

@Deprecatedpublic static void clearCache()

public static PropertyDescriptor createPropertyDescriptor(Class declaringClass, MetaProperty property)

public static ClassPropertyFetcher forClass(Class c)

public Field getDeclaredField(String name)

public static Object getInstancePropertyValue(Object instance, String name)

public Class getJavaClass()

public List<MetaProperty> getMetaProperties()

@SuppressWarnings("unchecked")public List<PropertyDescriptor> getPropertiesAssignableFromType(Class assignableType)

@SuppressWarnings("unchecked")public List<PropertyDescriptor> getPropertiesAssignableToType(Class assignableType)

public List<PropertyDescriptor> getPropertiesOfType(Class javaClass)

public PropertyDescriptor getPropertyDescriptor(String name)

@Deprecatedpublic PropertyDescriptor[] getPropertyDescriptors()

public Class getPropertyType(String name)

public Class getPropertyType(String name, boolean onlyInstanceProperties)

public static Class<?> getPropertyType(Class<?> cls, String propertyName)

public Object getPropertyValue(String name)

public Object getPropertyValue(Object instance, String name)

<T> public T getPropertyValue(String name, Class<T> c)

@Deprecatedpublic Object getReference()

<T> public T getStaticPropertyValue(String name, Class<T> c)

<T> public static T getStaticPropertyValue(Class clazz, String name, Class<T> requiredType)

<T> public List<T> getStaticPropertyValuesFromInheritanceHierarchy(String name, Class<T> c)

<T> public static List<T> getStaticPropertyValuesFromInheritanceHierarchy(Class theClass, String name, Class<T> requiredTyped)

public boolean isReadableProperty(String name)

@Deprecated
public static void clearCache()

@SuppressWarnings("unchecked")
public List<PropertyDescriptor> getPropertiesAssignableFromType(Class assignableType)

@SuppressWarnings("unchecked")
public List<PropertyDescriptor> getPropertiesAssignableToType(Class assignableType)

@Deprecated
public PropertyDescriptor[] getPropertyDescriptors()

@Deprecated
public Object getReference()