com.opensymphony.xwork2.util.reflection
Interface ReflectionProvider

All Known Implementing Classes:
OgnlReflectionProvider

public interface ReflectionProvider


Method Summary
 void copy(java.lang.Object from, java.lang.Object to, java.util.Map<java.lang.String,java.lang.Object> context, java.util.Collection<java.lang.String> exclusions, java.util.Collection<java.lang.String> inclusions)
          Copies the properties in the object "from" and sets them in the object "to" using specified type converter, or XWorkConverter if none is specified.
 java.util.Map<java.lang.String,java.lang.Object> getBeanMap(java.lang.Object source)
          Creates a Map with read properties for the given source object.
 java.lang.reflect.Field getField(java.lang.Class inClass, java.lang.String name)
           
 java.lang.reflect.Method getGetMethod(java.lang.Class targetClass, java.lang.String propertyName)
           
 java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.Class targetClass, java.lang.String propertyName)
          This method returns a PropertyDescriptor for the given class and property name using a Map lookup (using getPropertyDescriptorsMap()).
 java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Object source)
          Get's the java beans property descriptors for the given source.
 java.lang.Object getRealTarget(java.lang.String property, java.util.Map<java.lang.String,java.lang.Object> context, java.lang.Object root)
          Looks for the real target with the specified property given a root Object which may be a CompoundRoot.
 java.lang.reflect.Method getSetMethod(java.lang.Class targetClass, java.lang.String propertyName)
           
 java.lang.Object getValue(java.lang.String expression, java.util.Map<java.lang.String,java.lang.Object> context, java.lang.Object root)
          Evaluates the given OGNL expression to extract a value from the given root object in a given context
 void setProperties(java.util.Map<java.lang.String,java.lang.String> properties, java.lang.Object o)
          Sets the properties on the object using the default context, defaulting to not throwing exceptions for problems setting the properties.
 void setProperties(java.util.Map<java.lang.String,java.lang.String> props, java.lang.Object o, java.util.Map<java.lang.String,java.lang.Object> context)
          Sets the object's properties using the default type converter, defaulting to not throw exceptions for problems setting the properties.
 void setProperties(java.util.Map<java.lang.String,java.lang.String> props, java.lang.Object o, java.util.Map<java.lang.String,java.lang.Object> context, boolean throwPropertyExceptions)
          Sets the object's properties using the default type converter.
 void setProperty(java.lang.String name, java.lang.Object value, java.lang.Object o, java.util.Map<java.lang.String,java.lang.Object> context)
          Sets the named property to the supplied value on the Object, defaults to not throwing property exceptions.
 void setProperty(java.lang.String name, java.lang.Object value, java.lang.Object o, java.util.Map<java.lang.String,java.lang.Object> context, boolean throwPropertyExceptions)
          Sets the named property to the supplied value on the Object,
 void setValue(java.lang.String expression, java.util.Map<java.lang.String,java.lang.Object> context, java.lang.Object root, java.lang.Object value)
          Evaluates the given OGNL expression to insert a value into the object graph rooted at the given root object given the context.
 

Method Detail

getGetMethod

java.lang.reflect.Method getGetMethod(java.lang.Class targetClass,
                                      java.lang.String propertyName)
                                      throws java.beans.IntrospectionException,
                                             ReflectionException
Throws:
java.beans.IntrospectionException
ReflectionException

getSetMethod

java.lang.reflect.Method getSetMethod(java.lang.Class targetClass,
                                      java.lang.String propertyName)
                                      throws java.beans.IntrospectionException,
                                             ReflectionException
Throws:
java.beans.IntrospectionException
ReflectionException

getField

java.lang.reflect.Field getField(java.lang.Class inClass,
                                 java.lang.String name)

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> props,
                   java.lang.Object o,
                   java.util.Map<java.lang.String,java.lang.Object> context)
Sets the object's properties using the default type converter, defaulting to not throw exceptions for problems setting the properties.

Parameters:
props - the properties being set
o - the object
context - the action context

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> props,
                   java.lang.Object o,
                   java.util.Map<java.lang.String,java.lang.Object> context,
                   boolean throwPropertyExceptions)
                   throws ReflectionException
Sets the object's properties using the default type converter.

Parameters:
props - the properties being set
o - the object
context - the action context
throwPropertyExceptions - boolean which tells whether it should throw exceptions for problems setting the properties
Throws:
ReflectionException

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> properties,
                   java.lang.Object o)
Sets the properties on the object using the default context, defaulting to not throwing exceptions for problems setting the properties.

Parameters:
properties -
o -

getPropertyDescriptor

java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.Class targetClass,
                                                    java.lang.String propertyName)
                                                    throws java.beans.IntrospectionException,
                                                           ReflectionException
This method returns a PropertyDescriptor for the given class and property name using a Map lookup (using getPropertyDescriptorsMap()).

Throws:
java.beans.IntrospectionException
ReflectionException

copy

void copy(java.lang.Object from,
          java.lang.Object to,
          java.util.Map<java.lang.String,java.lang.Object> context,
          java.util.Collection<java.lang.String> exclusions,
          java.util.Collection<java.lang.String> inclusions)
Copies the properties in the object "from" and sets them in the object "to" using specified type converter, or XWorkConverter if none is specified.

Parameters:
from - the source object
to - the target object
context - the action context we're running under
exclusions - collection of method names to excluded from copying ( can be null)
inclusions - collection of method names to included copying (can be null) note if exclusions AND inclusions are supplied and not null nothing will get copied.

getRealTarget

java.lang.Object getRealTarget(java.lang.String property,
                               java.util.Map<java.lang.String,java.lang.Object> context,
                               java.lang.Object root)
                               throws ReflectionException
Looks for the real target with the specified property given a root Object which may be a CompoundRoot.

Returns:
the real target or null if no object can be found with the specified property
Throws:
ReflectionException

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value,
                 java.lang.Object o,
                 java.util.Map<java.lang.String,java.lang.Object> context,
                 boolean throwPropertyExceptions)
Sets the named property to the supplied value on the Object,

Parameters:
name - the name of the property to be set
value - the value to set into the named property
o - the object upon which to set the property
context - the context which may include the TypeConverter
throwPropertyExceptions - boolean which tells whether it should throw exceptions for problems setting the properties

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value,
                 java.lang.Object o,
                 java.util.Map<java.lang.String,java.lang.Object> context)
Sets the named property to the supplied value on the Object, defaults to not throwing property exceptions.

Parameters:
name - the name of the property to be set
value - the value to set into the named property
o - the object upon which to set the property
context - the context which may include the TypeConverter

getBeanMap

java.util.Map<java.lang.String,java.lang.Object> getBeanMap(java.lang.Object source)
                                                            throws java.beans.IntrospectionException,
                                                                   ReflectionException
Creates a Map with read properties for the given source object.

If the source object does not have a read property (i.e. write-only) then the property is added to the map with the value here is no read method for property-name.

Parameters:
source - the source object.
Returns:
a Map with (key = read property name, value = value of read property).
Throws:
java.beans.IntrospectionException - is thrown if an exception occurs during introspection.
ReflectionException

getValue

java.lang.Object getValue(java.lang.String expression,
                          java.util.Map<java.lang.String,java.lang.Object> context,
                          java.lang.Object root)
                          throws ReflectionException
Evaluates the given OGNL expression to extract a value from the given root object in a given context

Parameters:
expression - the OGNL expression to be parsed
context - the naming context for the evaluation
root - the root object for the OGNL expression
Returns:
the result of evaluating the expression
Throws:
ReflectionException

setValue

void setValue(java.lang.String expression,
              java.util.Map<java.lang.String,java.lang.Object> context,
              java.lang.Object root,
              java.lang.Object value)
              throws ReflectionException
Evaluates the given OGNL expression to insert a value into the object graph rooted at the given root object given the context.

Parameters:
expression - the OGNL expression to be parsed
root - the root object for the OGNL expression
context - the naming context for the evaluation
value - the value to insert into the object graph
Throws:
ReflectionException

getPropertyDescriptors

java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Object source)
                                                       throws java.beans.IntrospectionException
Get's the java beans property descriptors for the given source.

Parameters:
source - the source object.
Returns:
property descriptors.
Throws:
java.beans.IntrospectionException - is thrown if an exception occurs during introspection.


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.