Class ReflectivePropertyAccessor

Constructor Detail

• ReflectivePropertyAccessor

  public ReflectivePropertyAccessor()

  Create a new property accessor for reading as well writing.

  See Also:

  ReflectivePropertyAccessor(boolean)

• ReflectivePropertyAccessor

  public ReflectivePropertyAccessor​(boolean allowWrite)

  Create a new property accessor for reading and possibly also writing.

  Parameters:

  allowWrite - whether to allow write operations on a target instance

  Since:

  4.3.15

  See Also:

  canWrite(org.springframework.expression.EvaluationContext, java.lang.Object, java.lang.String)

Method Detail

• getSpecificTargetClasses

  public 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,
                         Object target,
                         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

• read

  public TypedValue read​(EvaluationContext context,
                         Object target,
                         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,
                          Object target,
                          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,
                    Object target,
                    String name,
                    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

• getLastReadInvokerPair

  @Deprecated
  public Member getLastReadInvokerPair()

  Deprecated.

  as of 4.3.15 since it is not used within the framework anymore
  Get the last read invoker pair.

• findGetterForProperty

  protected Method findGetterForProperty​(String propertyName,
                                         Class<?> clazz,
                                         boolean mustBeStatic)

  Find a getter method for the specified property.

• findSetterForProperty

  protected Method findSetterForProperty​(String propertyName,
                                         Class<?> clazz,
                                         boolean mustBeStatic)

  Find a setter method for the specified property.

• isCandidateForProperty

  protected boolean isCandidateForProperty​(Method method,
                                           Class<?> targetClass)

  Determine whether the given Method is a candidate for property access on an instance of the given target class.

  The default implementation considers any method as a candidate, even for non-user-declared properties on the Object base class.

  Parameters:

  method - the Method to evaluate

  targetClass - the concrete target class that is being introspected

  Since:

  4.3.15

• getPropertyMethodSuffixes

  protected String[] getPropertyMethodSuffixes​(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 String getPropertyMethodSuffix​(String propertyName)

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

• findField

  protected Field findField​(String name,
                            Class<?> clazz,
                            boolean mustBeStatic)

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

• createOptimalAccessor

  public PropertyAccessor createOptimalAccessor​(EvaluationContext context,
                                                Object target,
                                                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 a more optimal accessor.

  Note: An optimal accessor is currently only usable for read attempts. Do not call this method if you need a read-write accessor.

  See Also:

  ReflectivePropertyAccessor.OptimalPropertyAccessor