org.springframework.expression.spel.support

Class ReflectivePropertyAccessor

java.lang.Object

org.springframework.expression.spel.support.ReflectivePropertyAccessor

All Implemented Interfaces:

PropertyAccessor

public class ReflectivePropertyAccessor
extends java.lang.Object
implements PropertyAccessor

Simple PropertyAccessor that uses reflection to access properties for reading and writing.

A property can be accessed through a public getter method (when being read) or a public setter method (when being written), and also as a public field.

Since:

3.0

Author:

Andy Clement, Juergen Hoeller, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ReflectivePropertyAccessor.CacheKey
private static class	ReflectivePropertyAccessor.InvokerPair Captures the member (method/field) to call reflectively to access a property value and the type descriptor for the value returned by the reflective call.
static class	ReflectivePropertyAccessor.OptimalPropertyAccessor An optimized form of a PropertyAccessor that will use reflection but only knows how to access a particular property on a particular class.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Set<java.lang.Class<?>>	ANY_TYPES
private static java.util.Set<java.lang.Class<?>>	BOOLEAN_TYPES
private ReflectivePropertyAccessor.InvokerPair	lastReadInvokerPair
private java.util.Map<ReflectivePropertyAccessor.CacheKey,ReflectivePropertyAccessor.InvokerPair>	readerCache
private java.util.Map<ReflectivePropertyAccessor.CacheKey,TypeDescriptor>	typeDescriptorCache
private java.util.Map<ReflectivePropertyAccessor.CacheKey,java.lang.reflect.Member>	writerCache

Constructor Summary

Constructors

Constructor and Description
ReflectivePropertyAccessor()

Method Summary

Modifier and Type	Method and Description
boolean	canRead(EvaluationContext context, java.lang.Object target, java.lang.String name) Called to determine if a resolver instance is able to access a specified property on a specified target object.
boolean	canWrite(EvaluationContext context, java.lang.Object target, java.lang.String name) Called to determine if a resolver instance is able to write to a specified property on a specified target object.
PropertyAccessor	createOptimalAccessor(EvaluationContext evalContext, java.lang.Object target, java.lang.String name) Attempt to create an optimized property accessor tailored for a property of a particular name on a particular class.
protected java.lang.reflect.Field	findField(java.lang.String name, java.lang.Class<?> clazz, boolean mustBeStatic) Find a field of a certain name on a specified class.
private java.lang.reflect.Field	findField(java.lang.String name, java.lang.Class<?> clazz, java.lang.Object target)
protected java.lang.reflect.Method	findGetterForProperty(java.lang.String propertyName, java.lang.Class<?> clazz, boolean mustBeStatic) Find a getter method for the specified property.
private java.lang.reflect.Method	findGetterForProperty(java.lang.String propertyName, java.lang.Class<?> clazz, java.lang.Object target)
private java.lang.reflect.Method	findMethodForProperty(java.lang.String[] methodSuffixes, java.lang.String prefix, java.lang.Class<?> clazz, boolean mustBeStatic, int numberOfParams, java.util.Set<java.lang.Class<?>> requiredReturnTypes)
protected java.lang.reflect.Method	findSetterForProperty(java.lang.String propertyName, java.lang.Class<?> clazz, boolean mustBeStatic) Find a setter method for the specified property.
private java.lang.reflect.Method	findSetterForProperty(java.lang.String propertyName, java.lang.Class<?> clazz, java.lang.Object target)
java.lang.reflect.Member	getLastReadInvokerPair()
protected java.lang.String	getPropertyMethodSuffix(java.lang.String propertyName) Return the method suffix for a given property name.
protected java.lang.String[]	getPropertyMethodSuffixes(java.lang.String propertyName) Return the method suffixes for a given property name.
private java.lang.reflect.Method[]	getSortedClassMethods(java.lang.Class<?> clazz) Returns class methods ordered with non bridge methods appearing higher.
java.lang.Class<?>[]	getSpecificTargetClasses() Returns null which means this is a general purpose accessor.
private TypeDescriptor	getTypeDescriptor(EvaluationContext context, java.lang.Object target, java.lang.String name)
TypedValue	read(EvaluationContext context, java.lang.Object target, java.lang.String name) Called to read a property from a specified target object.
void	write(EvaluationContext context, java.lang.Object target, java.lang.String name, java.lang.Object newValue) Called to write to a property on a specified target object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BOOLEAN_TYPES

private static final java.util.Set<java.lang.Class<?>> BOOLEAN_TYPES

ANY_TYPES

private static final java.util.Set<java.lang.Class<?>> ANY_TYPES

readerCache

private final java.util.Map<ReflectivePropertyAccessor.CacheKey,ReflectivePropertyAccessor.InvokerPair> readerCache

writerCache

private final java.util.Map<ReflectivePropertyAccessor.CacheKey,java.lang.reflect.Member> writerCache

typeDescriptorCache

private final java.util.Map<ReflectivePropertyAccessor.CacheKey,TypeDescriptor> typeDescriptorCache

lastReadInvokerPair

private ReflectivePropertyAccessor.InvokerPair lastReadInvokerPair

Constructor Detail

ReflectivePropertyAccessor

public ReflectivePropertyAccessor()

Method Detail

getSpecificTargetClasses

public java.lang.Class<?>[] getSpecificTargetClasses()

Returns null which means this is a general purpose accessor.

Specified by:

getSpecificTargetClasses in interface PropertyAccessor

Returns:

an array of classes that this resolver is suitable for (or null if a general resolver)

canRead

public boolean canRead(EvaluationContext context,
                       java.lang.Object target,
                       java.lang.String name)
                throws AccessException

Description copied from interface: PropertyAccessor

Called to determine if a resolver instance is able to access a specified property on a specified target object.

Specified by:

canRead in interface PropertyAccessor

Parameters:

context - the evaluation context in which the access is being attempted

target - the target object upon which the property is being accessed

name - the name of the property being accessed

Returns:

true if this resolver is able to read the property

Throws:

AccessException - if there is any problem determining whether the property can be read

getLastReadInvokerPair

public java.lang.reflect.Member getLastReadInvokerPair()

read

public TypedValue read(EvaluationContext context,
                       java.lang.Object target,
                       java.lang.String name)
                throws AccessException

Description copied from interface: PropertyAccessor

Called to read a property from a specified target object. Should only succeed if PropertyAccessor.canRead(org.springframework.expression.EvaluationContext, java.lang.Object, java.lang.String) also returns true.

Specified by:

read in interface PropertyAccessor

Parameters:

context - the evaluation context in which the access is being attempted

target - the target object upon which the property is being accessed

name - the name of the property being accessed

Returns:

a TypedValue object wrapping the property value read and a type descriptor for it

Throws:

AccessException - if there is any problem accessing the property value

canWrite

public boolean canWrite(EvaluationContext context,
                        java.lang.Object target,
                        java.lang.String name)
                 throws AccessException

Description copied from interface: PropertyAccessor

Called to determine if a resolver instance is able to write to a specified property on a specified target object.

Specified by:

canWrite in interface PropertyAccessor

Parameters:

context - the evaluation context in which the access is being attempted

target - the target object upon which the property is being accessed

name - the name of the property being accessed

Returns:

true if this resolver is able to write to the property

Throws:

AccessException - if there is any problem determining whether the property can be written to

write

public void write(EvaluationContext context,
                  java.lang.Object target,
                  java.lang.String name,
                  java.lang.Object newValue)
           throws AccessException

Description copied from interface: PropertyAccessor

Called to write to a property on a specified target object. Should only succeed if PropertyAccessor.canWrite(org.springframework.expression.EvaluationContext, java.lang.Object, java.lang.String) also returns true.

Specified by:

write in interface PropertyAccessor

Parameters:

context - the evaluation context in which the access is being attempted

target - the target object upon which the property is being accessed

name - the name of the property being accessed

newValue - the new value for the property

Throws:

AccessException - if there is any problem writing to the property value

getTypeDescriptor

private TypeDescriptor getTypeDescriptor(EvaluationContext context,
                                         java.lang.Object target,
                                         java.lang.String name)

findGetterForProperty

private java.lang.reflect.Method findGetterForProperty(java.lang.String propertyName,
                                                       java.lang.Class<?> clazz,
                                                       java.lang.Object target)

findSetterForProperty

private java.lang.reflect.Method findSetterForProperty(java.lang.String propertyName,
                                                       java.lang.Class<?> clazz,
                                                       java.lang.Object target)

findField

private java.lang.reflect.Field findField(java.lang.String name,
                                          java.lang.Class<?> clazz,
                                          java.lang.Object target)

findGetterForProperty

protected java.lang.reflect.Method findGetterForProperty(java.lang.String propertyName,
                                                         java.lang.Class<?> clazz,
                                                         boolean mustBeStatic)

Find a getter method for the specified property.

findSetterForProperty

protected java.lang.reflect.Method findSetterForProperty(java.lang.String propertyName,
                                                         java.lang.Class<?> clazz,
                                                         boolean mustBeStatic)

Find a setter method for the specified property.

findMethodForProperty

private java.lang.reflect.Method findMethodForProperty(java.lang.String[] methodSuffixes,
                                                       java.lang.String prefix,
                                                       java.lang.Class<?> clazz,
                                                       boolean mustBeStatic,
                                                       int numberOfParams,
                                                       java.util.Set<java.lang.Class<?>> requiredReturnTypes)

getSortedClassMethods

private java.lang.reflect.Method[] getSortedClassMethods(java.lang.Class<?> clazz)

Returns class methods ordered with non bridge methods appearing higher.

getPropertyMethodSuffixes

protected java.lang.String[] getPropertyMethodSuffixes(java.lang.String propertyName)

Return the method suffixes for a given property name. The default implementation uses JavaBean conventions with additional support for properties of the form 'xY' where the method 'getXY()' is used in preference to the JavaBean convention of 'getxY()'.

getPropertyMethodSuffix

protected java.lang.String getPropertyMethodSuffix(java.lang.String propertyName)

Return the method suffix for a given property name. The default implementation uses JavaBean conventions.

findField

protected java.lang.reflect.Field findField(java.lang.String name,
                                            java.lang.Class<?> clazz,
                                            boolean mustBeStatic)

Find a field of a certain name on a specified class.

createOptimalAccessor

public PropertyAccessor createOptimalAccessor(EvaluationContext evalContext,
                                              java.lang.Object target,
                                              java.lang.String name)

Attempt to create an optimized property accessor tailored for a property of a particular name on a particular class. The general ReflectivePropertyAccessor will always work but is not optimal due to the need to lookup which reflective member (method/field) to use each time read() is called. This method will just return the ReflectivePropertyAccessor instance if it is unable to build something more optimal.