PropertyUtils (Bean Introspection Utilities (Version 1.6.1))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.beanutils
Class PropertyUtils

java.lang.Object
  |
  +--org.apache.commons.beanutils.PropertyUtils

public class PropertyUtils
extends java.lang.Object

Utility methods for using Java Reflection APIs to facilitate generic property getter and setter operations on Java objects. Much of this code was originally included in BeanUtils, but has been separated because of the volume of code involved.

In general, the objects that are examined and modified using these methods are expected to conform to the property getter and setter method naming conventions described in the JavaBeans Specification (Version 1.0.1). No data type conversions are performed, and there are no usage of any PropertyEditor classes that have been registered, although a convenient way to access the registered classes themselves is included.

For the purposes of this class, five formats for referencing a particular property value of a bean are defined, with the layout of an identifying String in parentheses:

Simple (name) - The specified name identifies an individual property of a particular JavaBean. The name of the actual getter or setter method to be used is determined using standard JavaBeans instrospection, so that (unless overridden by a BeanInfo class, a property named "xyz" will have a getter method named getXyz() or (for boolean properties only) isXyz(), and a setter method named setXyz().
Nested (name1.name2.name3) The first name element is used to select a property getter, as for simple references above. The object returned for this property is then consulted, using the same approach, for a property getter for a property named name2, and so on. The property value that is ultimately retrieved or modified is the one identified by the last name element.
Indexed (name[index]) - The underlying property value is assumed to be an array, or this JavaBean is assumed to have indexed property getter and setter methods. The appropriate (zero-relative) entry in the array is selected. List objects are now also supported for read/write. You simply need to define a getter that returns the List
Mapped (name(key)) - The JavaBean is assumed to have an property getter and setter methods with an additional attribute of type java.lang.String.
Combined (name1.name2[index].name3(key)) - Combining mapped, nested, and indexed references is also supported.

Version:: $Revision: 1.38 $ $Date: 2003/01/15 21:59:39 $
Author:: Craig R. McClanahan, Ralph Schaer, Chris Audley, Rey François, Gregor Raıman, Jan Sorensen, Scott Sanders

Field Summary

private static int debug
          Deprecated. The debug static property is no longer used

private static org.apache.commons.collections.FastHashMap descriptorsCache
          The cache of PropertyDescriptor arrays for beans we have already introspected, keyed by the java.lang.Class of this object.

static char INDEXED_DELIM
          The delimiter that preceeds the zero-relative subscript for an indexed reference.

static char INDEXED_DELIM2
          The delimiter that follows the zero-relative subscript for an indexed reference.

static char MAPPED_DELIM
          The delimiter that preceeds the key of a mapped property.

static char MAPPED_DELIM2
          The delimiter that follows the key of a mapped property.

private static org.apache.commons.collections.FastHashMap mappedDescriptorsCache


static char NESTED_DELIM
          The delimiter that separates the components of a nested reference.

Constructor Summary

PropertyUtils()


Method Summary

static void clearDescriptors()
          Clear any cached property descriptors information for all classes loaded by any class loaders.

static void copyProperties(java.lang.Object dest, java.lang.Object orig)
          Copy property values from the "origin" bean to the "destination" bean for all cases where the property names are the same (even though the actual getter and setter methods might have been customized via BeanInfo classes).

static java.util.Map describe(java.lang.Object bean)
          Return the entire set of properties for which the specified bean provides a read method.

static int getDebug()
          Deprecated. The debug static property is no longer used

static java.lang.Object getIndexedProperty(java.lang.Object bean, java.lang.String name)
          Return the value of the specified indexed property of the specified bean, with no type conversions.

static java.lang.Object getIndexedProperty(java.lang.Object bean, java.lang.String name, int index)
          Return the value of the specified indexed property of the specified bean, with no type conversions.

static java.lang.Object getMappedProperty(java.lang.Object bean, java.lang.String name)
          Return the value of the specified mapped property of the specified bean, with no type conversions.

static java.lang.Object getMappedProperty(java.lang.Object bean, java.lang.String name, java.lang.String key)
          Return the value of the specified mapped property of the specified bean, with no type conversions.

static org.apache.commons.collections.FastHashMap getMappedPropertyDescriptors(java.lang.Class beanClass)
          Return the mapped property descriptors for this bean class.

static org.apache.commons.collections.FastHashMap getMappedPropertyDescriptors(java.lang.Object bean)
          Return the mapped property descriptors for this bean.

static java.lang.Object getNestedProperty(java.lang.Object bean, java.lang.String name)
          Return the value of the (possibly nested) property of the specified name, for the specified bean, with no type conversions.

static java.lang.Object getProperty(java.lang.Object bean, java.lang.String name)
          Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.

static java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.Object bean, java.lang.String name)
          Retrieve the property descriptor for the specified property of the specified bean, or return null if there is no such descriptor.

static java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Class beanClass)
          Retrieve the property descriptors for the specified class, introspecting and caching them the first time a particular bean class is encountered.

static java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Object bean)
          Retrieve the property descriptors for the specified bean, introspecting and caching them the first time a particular bean class is encountered.

static java.lang.Class getPropertyEditorClass(java.lang.Object bean, java.lang.String name)
          Return the Java Class repesenting the property editor class that has been registered for this property (if any).

static java.lang.Class getPropertyType(java.lang.Object bean, java.lang.String name)
          Return the Java Class representing the property type of the specified property, or null if there is no such property for the specified bean.

static java.lang.reflect.Method getReadMethod(java.beans.PropertyDescriptor descriptor)
          Return an accessible property getter method for this property, if there is one; otherwise return null.

static java.lang.Object getSimpleProperty(java.lang.Object bean, java.lang.String name)
          Return the value of the specified simple property of the specified bean, with no type conversions.

static java.lang.reflect.Method getWriteMethod(java.beans.PropertyDescriptor descriptor)
          Return an accessible property setter method for this property, if there is one; otherwise return null.

static boolean isReadable(java.lang.Object bean, java.lang.String name)
          Return true if the specified property name identifies a readable property on the specified bean; otherwise, return false.

static boolean isWriteable(java.lang.Object bean, java.lang.String name)
          Return true if the specified property name identifies a writeable property on the specified bean; otherwise, return false.

static void setDebug(int newDebug)
          Deprecated. The debug static property is no longer used

static void setIndexedProperty(java.lang.Object bean, java.lang.String name, int index, java.lang.Object value)
          Set the value of the specified indexed property of the specified bean, with no type conversions.

static void setIndexedProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)
          Set the value of the specified indexed property of the specified bean, with no type conversions.

static void setMappedProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)
          Set the value of the specified mapped property of the specified bean, with no type conversions.

static void setMappedProperty(java.lang.Object bean, java.lang.String name, java.lang.String key, java.lang.Object value)
          Set the value of the specified mapped property of the specified bean, with no type conversions.

static void setNestedProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)
          Set the value of the (possibly nested) property of the specified name, for the specified bean, with no type conversions.

static void setProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)
          Set the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.

static void setSimpleProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)
          Set the value of the specified simple property of the specified bean, with no type conversions.

Methods inherited from class java.lang.Object

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

Field Detail

INDEXED_DELIM

public static final char INDEXED_DELIM

The delimiter that preceeds the zero-relative subscript for an indexed reference.

See Also:: Constant Field Values

INDEXED_DELIM2

public static final char INDEXED_DELIM2

The delimiter that follows the zero-relative subscript for an indexed reference.

See Also:: Constant Field Values

MAPPED_DELIM

public static final char MAPPED_DELIM

The delimiter that preceeds the key of a mapped property.

See Also:: Constant Field Values

MAPPED_DELIM2

public static final char MAPPED_DELIM2

The delimiter that follows the key of a mapped property.

See Also:: Constant Field Values

NESTED_DELIM

public static final char NESTED_DELIM

The delimiter that separates the components of a nested reference.

See Also:: Constant Field Values

debug

private static int debug

Deprecated. The debug static property is no longer used

The debugging detail level for this component.

descriptorsCache

private static org.apache.commons.collections.FastHashMap descriptorsCache

The cache of PropertyDescriptor arrays for beans we have already introspected, keyed by the java.lang.Class of this object.

mappedDescriptorsCache

private static org.apache.commons.collections.FastHashMap mappedDescriptorsCache

Constructor Detail

PropertyUtils

public PropertyUtils()

Method Detail

getDebug

public static int getDebug()

Deprecated. The debug static property is no longer used

setDebug

public static void setDebug(int newDebug)

Deprecated. The debug static property is no longer used

clearDescriptors

public static void clearDescriptors()

Clear any cached property descriptors information for all classes loaded by any class loaders. This is useful in cases where class loaders are thrown away to implement class reloading.

copyProperties

public static void copyProperties(java.lang.Object dest,
                                  java.lang.Object orig)
                           throws java.lang.IllegalAccessException,
                                  java.lang.reflect.InvocationTargetException,
                                  java.lang.NoSuchMethodException

Copy property values from the "origin" bean to the "destination" bean for all cases where the property names are the same (even though the actual getter and setter methods might have been customized via BeanInfo classes). No conversions are performed on the actual property values -- it is assumed that the values retrieved from the origin bean are assignment-compatible with the types expected by the destination bean.

If the origin "bean" is actually a Map, it is assumed to contain String-valued simple property names as the keys, pointing at the corresponding property values that will be set in the destination bean.Note that this method is intended to perform a "shallow copy" of the properties and so complex properties (for example, nested ones) will not be copied.

Parameters:: dest - Destination bean whose properties are modified; orig - Origin bean whose properties are retrieved
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if the dest or orig argument is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

describe

public static java.util.Map describe(java.lang.Object bean)
                              throws java.lang.IllegalAccessException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.NoSuchMethodException

Return the entire set of properties for which the specified bean provides a read method. This map contains the unconverted property values for all properties for which a read method is provided (i.e. where the getReadMethod() returns non-null).

FIXME - Does not account for mapped properties.

Parameters:: bean - Bean whose properties are to be extracted
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getIndexedProperty

public static java.lang.Object getIndexedProperty(java.lang.Object bean,
                                                  java.lang.String name)
                                           throws java.lang.IllegalAccessException,
                                                  java.lang.reflect.InvocationTargetException,
                                                  java.lang.NoSuchMethodException

Return the value of the specified indexed property of the specified bean, with no type conversions. The zero-relative index of the required value must be included (in square brackets) as a suffix to the property name, or IllegalArgumentException will be thrown. In addition to supporting the JavaBeans specification, this method has been extended to support List objects as well.

Parameters:: bean - Bean whose property is to be extracted; name - propertyname[index] of the property value to be extracted
Throws:: java.lang.ArrayIndexOutOfBoundsException - if the specified index is outside the valid range for the underlying array; java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getIndexedProperty

public static java.lang.Object getIndexedProperty(java.lang.Object bean,
                                                  java.lang.String name,
                                                  int index)
                                           throws java.lang.IllegalAccessException,
                                                  java.lang.reflect.InvocationTargetException,
                                                  java.lang.NoSuchMethodException

Return the value of the specified indexed property of the specified bean, with no type conversions. In addition to supporting the JavaBeans specification, this method has been extended to support List objects as well.

Parameters:: bean - Bean whose property is to be extracted; name - Simple property name of the property value to be extracted; index - Index of the property value to be extracted
Throws:: java.lang.ArrayIndexOutOfBoundsException - if the specified index is outside the valid range for the underlying array; java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getMappedProperty

public static java.lang.Object getMappedProperty(java.lang.Object bean,
                                                 java.lang.String name)
                                          throws java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.NoSuchMethodException

Return the value of the specified mapped property of the specified bean, with no type conversions. The key of the required value must be included (in brackets) as a suffix to the property name, or IllegalArgumentException will be thrown.

Parameters:: bean - Bean whose property is to be extracted; name - propertyname(key) of the property value to be extracted
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getMappedProperty

public static java.lang.Object getMappedProperty(java.lang.Object bean,
                                                 java.lang.String name,
                                                 java.lang.String key)
                                          throws java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.NoSuchMethodException

Return the value of the specified mapped property of the specified bean, with no type conversions.

Parameters:: bean - Bean whose property is to be extracted; name - Mapped property name of the property value to be extracted; key - Key of the property value to be extracted
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getMappedPropertyDescriptors

public static org.apache.commons.collections.FastHashMap getMappedPropertyDescriptors(java.lang.Class beanClass)

Return the mapped property descriptors for this bean class.

FIXME - Does not work with DynaBeans.

Parameters:: beanClass - Bean class to be introspected

getMappedPropertyDescriptors

public static org.apache.commons.collections.FastHashMap getMappedPropertyDescriptors(java.lang.Object bean)

Return the mapped property descriptors for this bean.

FIXME - Does not work with DynaBeans.

Parameters:: bean - Bean to be introspected

getNestedProperty

public static java.lang.Object getNestedProperty(java.lang.Object bean,
                                                 java.lang.String name)
                                          throws java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.NoSuchMethodException

Return the value of the (possibly nested) property of the specified name, for the specified bean, with no type conversions.

Parameters:: bean - Bean whose property is to be extracted; name - Possibly nested name of the property to be extracted
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if a nested reference to a property returns null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getProperty

public static java.lang.Object getProperty(java.lang.Object bean,
                                           java.lang.String name)
                                    throws java.lang.IllegalAccessException,
                                           java.lang.reflect.InvocationTargetException,
                                           java.lang.NoSuchMethodException

Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.

Parameters:: bean - Bean whose property is to be extracted; name - Possibly indexed and/or nested name of the property to be extracted
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getPropertyDescriptor

public static java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.Object bean,
                                                                  java.lang.String name)
                                                           throws java.lang.IllegalAccessException,
                                                                  java.lang.reflect.InvocationTargetException,
                                                                  java.lang.NoSuchMethodException

Retrieve the property descriptor for the specified property of the specified bean, or return null if there is no such descriptor. This method resolves indexed and nested property references in the same manner as other methods in this class, except that if the last (or only) name element is indexed, the descriptor for the last resolved property itself is returned.

FIXME - Does not work with DynaBeans.

Parameters:: bean - Bean for which a property descriptor is requested; name - Possibly indexed and/or nested name of the property for which a property descriptor is requested
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if a nested reference to a property returns null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getPropertyDescriptors

public static java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Class beanClass)

Retrieve the property descriptors for the specified class, introspecting and caching them the first time a particular bean class is encountered.

FIXME - Does not work with DynaBeans.

Parameters:: beanClass - Bean class for which property descriptors are requested
Throws:: java.lang.IllegalArgumentException - if beanClass is null

getPropertyDescriptors

public static java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Object bean)

Retrieve the property descriptors for the specified bean, introspecting and caching them the first time a particular bean class is encountered.

FIXME - Does not work with DynaBeans.

Parameters:: bean - Bean for which property descriptors are requested
Throws:: java.lang.IllegalArgumentException - if bean is null

getPropertyEditorClass

public static java.lang.Class getPropertyEditorClass(java.lang.Object bean,
                                                     java.lang.String name)
                                              throws java.lang.IllegalAccessException,
                                                     java.lang.reflect.InvocationTargetException,
                                                     java.lang.NoSuchMethodException

Return the Java Class repesenting the property editor class that has been registered for this property (if any). This method follows the same name resolution rules used by getPropertyDescriptor(), so if the last element of a name reference is indexed, the property editor for the underlying property's class is returned.

Note that null will be returned if there is no property, or if there is no registered property editor class. Because this return value is ambiguous, you should determine the existence of the property itself by other means.

FIXME - Does not work with DynaBeans.

Parameters:: bean - Bean for which a property descriptor is requested; name - Possibly indexed and/or nested name of the property for which a property descriptor is requested
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if a nested reference to a property returns null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getPropertyType

public static java.lang.Class getPropertyType(java.lang.Object bean,
                                              java.lang.String name)
                                       throws java.lang.IllegalAccessException,
                                              java.lang.reflect.InvocationTargetException,
                                              java.lang.NoSuchMethodException

Return the Java Class representing the property type of the specified property, or null if there is no such property for the specified bean. This method follows the same name resolution rules used by getPropertyDescriptor(), so if the last element of a name reference is indexed, the type of the property itself will be returned. If the last (or only) element has no property with the specified name, null is returned.

Parameters:: bean - Bean for which a property descriptor is requested; name - Possibly indexed and/or nested name of the property for which a property descriptor is requested
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if a nested reference to a property returns null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getReadMethod

public static java.lang.reflect.Method getReadMethod(java.beans.PropertyDescriptor descriptor)

Return an accessible property getter method for this property, if there is one; otherwise return null.

FIXME - Does not work with DynaBeans.

Parameters:: descriptor - Property descriptor to return a getter for

getSimpleProperty

public static java.lang.Object getSimpleProperty(java.lang.Object bean,
                                                 java.lang.String name)
                                          throws java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.NoSuchMethodException

Return the value of the specified simple property of the specified bean, with no type conversions.

Parameters:: bean - Bean whose property is to be extracted; name - Name of the property to be extracted
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if the property name is nested or indexed; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

getWriteMethod

public static java.lang.reflect.Method getWriteMethod(java.beans.PropertyDescriptor descriptor)

Return an accessible property setter method for this property, if there is one; otherwise return null.

FIXME - Does not work with DynaBeans.

Parameters:: descriptor - Property descriptor to return a setter for

isReadable

public static boolean isReadable(java.lang.Object bean,
                                 java.lang.String name)

Return true if the specified property name identifies a readable property on the specified bean; otherwise, return false.

Parameters:: bean - Bean to be examined (may be a DynaBean; name - Property name to be evaluated
Throws:: java.lang.IllegalArgumentException - if bean or name is null
Since:: BeanUtils 1.6

isWriteable

public static boolean isWriteable(java.lang.Object bean,
                                  java.lang.String name)

Return true if the specified property name identifies a writeable property on the specified bean; otherwise, return false.

Parameters:: bean - Bean to be examined (may be a DynaBean; name - Property name to be evaluated
Throws:: IllegalPointerException - if bean or name is null
Since:: BeanUtils 1.6

setIndexedProperty

public static void setIndexedProperty(java.lang.Object bean,
                                      java.lang.String name,
                                      java.lang.Object value)
                               throws java.lang.IllegalAccessException,
                                      java.lang.reflect.InvocationTargetException,
                                      java.lang.NoSuchMethodException

Set the value of the specified indexed property of the specified bean, with no type conversions. The zero-relative index of the required value must be included (in square brackets) as a suffix to the property name, or IllegalArgumentException will be thrown. In addition to supporting the JavaBeans specification, this method has been extended to support List objects as well.

Parameters:: bean - Bean whose property is to be modified; name - propertyname[index] of the property value to be modified; value - Value to which the specified property element should be set
Throws:: java.lang.ArrayIndexOutOfBoundsException - if the specified index is outside the valid range for the underlying array; java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

setIndexedProperty

public static void setIndexedProperty(java.lang.Object bean,
                                      java.lang.String name,
                                      int index,
                                      java.lang.Object value)
                               throws java.lang.IllegalAccessException,
                                      java.lang.reflect.InvocationTargetException,
                                      java.lang.NoSuchMethodException

Set the value of the specified indexed property of the specified bean, with no type conversions. In addition to supporting the JavaBeans specification, this method has been extended to support List objects as well.

Parameters:: bean - Bean whose property is to be set; name - Simple property name of the property value to be set; index - Index of the property value to be set; value - Value to which the indexed property element is to be set
Throws:: java.lang.ArrayIndexOutOfBoundsException - if the specified index is outside the valid range for the underlying array; java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

setMappedProperty

public static void setMappedProperty(java.lang.Object bean,
                                     java.lang.String name,
                                     java.lang.Object value)
                              throws java.lang.IllegalAccessException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.NoSuchMethodException

Set the value of the specified mapped property of the specified bean, with no type conversions. The key of the value to set must be included (in brackets) as a suffix to the property name, or IllegalArgumentException will be thrown.

Parameters:: bean - Bean whose property is to be set; name - propertyname(key) of the property value to be set; value - The property value to be set
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

setMappedProperty

public static void setMappedProperty(java.lang.Object bean,
                                     java.lang.String name,
                                     java.lang.String key,
                                     java.lang.Object value)
                              throws java.lang.IllegalAccessException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.NoSuchMethodException

Set the value of the specified mapped property of the specified bean, with no type conversions.

Parameters:: bean - Bean whose property is to be set; name - Mapped property name of the property value to be set; key - Key of the property value to be set; value - The property value to be set
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

setNestedProperty

public static void setNestedProperty(java.lang.Object bean,
                                     java.lang.String name,
                                     java.lang.Object value)
                              throws java.lang.IllegalAccessException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.NoSuchMethodException

Set the value of the (possibly nested) property of the specified name, for the specified bean, with no type conversions.

Parameters:: bean - Bean whose property is to be modified; name - Possibly nested name of the property to be modified; value - Value to which the property is to be set
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if a nested reference to a property returns null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

setProperty

public static void setProperty(java.lang.Object bean,
                               java.lang.String name,
                               java.lang.Object value)
                        throws java.lang.IllegalAccessException,
                               java.lang.reflect.InvocationTargetException,
                               java.lang.NoSuchMethodException

Set the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.

Parameters:: bean - Bean whose property is to be modified; name - Possibly indexed and/or nested name of the property to be modified; value - Value to which this property is to be set
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

setSimpleProperty

public static void setSimpleProperty(java.lang.Object bean,
                                     java.lang.String name,
                                     java.lang.Object value)
                              throws java.lang.IllegalAccessException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.NoSuchMethodException

Set the value of the specified simple property of the specified bean, with no type conversions.

Parameters:: bean - Bean whose property is to be modified; name - Name of the property to be modified; value - Value to which the property should be set
Throws:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.IllegalArgumentException - if bean or name is null; java.lang.IllegalArgumentException - if the property name is nested or indexed; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception; java.lang.NoSuchMethodException - if an accessor method for this propety cannot be found

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`private static int`	`debug` Deprecated. The `debug` static property is no longer used
`private static org.apache.commons.collections.FastHashMap`	`descriptorsCache` The cache of PropertyDescriptor arrays for beans we have already introspected, keyed by the java.lang.Class of this object.
`static char`	`INDEXED_DELIM` The delimiter that preceeds the zero-relative subscript for an indexed reference.
`static char`	`INDEXED_DELIM2` The delimiter that follows the zero-relative subscript for an indexed reference.
`static char`	`MAPPED_DELIM` The delimiter that preceeds the key of a mapped property.
`static char`	`MAPPED_DELIM2` The delimiter that follows the key of a mapped property.
`private static org.apache.commons.collections.FastHashMap`	`mappedDescriptorsCache`
`static char`	`NESTED_DELIM` The delimiter that separates the components of a nested reference.

Method Summary
`static void`	`clearDescriptors()` Clear any cached property descriptors information for all classes loaded by any class loaders.
`static void`	`copyProperties(java.lang.Object dest, java.lang.Object orig)` Copy property values from the "origin" bean to the "destination" bean for all cases where the property names are the same (even though the actual getter and setter methods might have been customized via `BeanInfo` classes).
`static java.util.Map`	`describe(java.lang.Object bean)` Return the entire set of properties for which the specified bean provides a read method.
`static int`	`getDebug()` Deprecated. The `debug` static property is no longer used
`static java.lang.Object`	`getIndexedProperty(java.lang.Object bean, java.lang.String name)` Return the value of the specified indexed property of the specified bean, with no type conversions.
`static java.lang.Object`	`getIndexedProperty(java.lang.Object bean, java.lang.String name, int index)` Return the value of the specified indexed property of the specified bean, with no type conversions.
`static java.lang.Object`	`getMappedProperty(java.lang.Object bean, java.lang.String name)` Return the value of the specified mapped property of the specified bean, with no type conversions.
`static java.lang.Object`	`getMappedProperty(java.lang.Object bean, java.lang.String name, java.lang.String key)` Return the value of the specified mapped property of the specified bean, with no type conversions.
`static org.apache.commons.collections.FastHashMap`	`getMappedPropertyDescriptors(java.lang.Class beanClass)` Return the mapped property descriptors for this bean class.
`static org.apache.commons.collections.FastHashMap`	`getMappedPropertyDescriptors(java.lang.Object bean)` Return the mapped property descriptors for this bean.
`static java.lang.Object`	`getNestedProperty(java.lang.Object bean, java.lang.String name)` Return the value of the (possibly nested) property of the specified name, for the specified bean, with no type conversions.
`static java.lang.Object`	`getProperty(java.lang.Object bean, java.lang.String name)` Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.
`static java.beans.PropertyDescriptor`	`getPropertyDescriptor(java.lang.Object bean, java.lang.String name)` Retrieve the property descriptor for the specified property of the specified bean, or return `null` if there is no such descriptor.
`static java.beans.PropertyDescriptor[]`	`getPropertyDescriptors(java.lang.Class beanClass)` Retrieve the property descriptors for the specified class, introspecting and caching them the first time a particular bean class is encountered.
`static java.beans.PropertyDescriptor[]`	`getPropertyDescriptors(java.lang.Object bean)` Retrieve the property descriptors for the specified bean, introspecting and caching them the first time a particular bean class is encountered.
`static java.lang.Class`	`getPropertyEditorClass(java.lang.Object bean, java.lang.String name)` Return the Java Class repesenting the property editor class that has been registered for this property (if any).
`static java.lang.Class`	`getPropertyType(java.lang.Object bean, java.lang.String name)` Return the Java Class representing the property type of the specified property, or `null` if there is no such property for the specified bean.
`static java.lang.reflect.Method`	`getReadMethod(java.beans.PropertyDescriptor descriptor)` Return an accessible property getter method for this property, if there is one; otherwise return `null`.
`static java.lang.Object`	`getSimpleProperty(java.lang.Object bean, java.lang.String name)` Return the value of the specified simple property of the specified bean, with no type conversions.
`static java.lang.reflect.Method`	`getWriteMethod(java.beans.PropertyDescriptor descriptor)` Return an accessible property setter method for this property, if there is one; otherwise return `null`.
`static boolean`	`isReadable(java.lang.Object bean, java.lang.String name)` Return `true` if the specified property name identifies a readable property on the specified bean; otherwise, return `false`.
`static boolean`	`isWriteable(java.lang.Object bean, java.lang.String name)` Return `true` if the specified property name identifies a writeable property on the specified bean; otherwise, return `false`.
`static void`	`setDebug(int newDebug)` Deprecated. The `debug` static property is no longer used
`static void`	`setIndexedProperty(java.lang.Object bean, java.lang.String name, int index, java.lang.Object value)` Set the value of the specified indexed property of the specified bean, with no type conversions.
`static void`	`setIndexedProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)` Set the value of the specified indexed property of the specified bean, with no type conversions.
`static void`	`setMappedProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)` Set the value of the specified mapped property of the specified bean, with no type conversions.
`static void`	`setMappedProperty(java.lang.Object bean, java.lang.String name, java.lang.String key, java.lang.Object value)` Set the value of the specified mapped property of the specified bean, with no type conversions.
`static void`	`setNestedProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)` Set the value of the (possibly nested) property of the specified name, for the specified bean, with no type conversions.
`static void`	`setProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)` Set the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.
`static void`	`setSimpleProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)` Set the value of the specified simple property of the specified bean, with no type conversions.

org.apache.commons.beanutils Class PropertyUtils

INDEXED_DELIM

INDEXED_DELIM2

MAPPED_DELIM

MAPPED_DELIM2

NESTED_DELIM

debug

descriptorsCache

mappedDescriptorsCache

PropertyUtils

getDebug

setDebug

clearDescriptors

copyProperties

describe

getIndexedProperty

getIndexedProperty

getMappedProperty

getMappedProperty

getMappedPropertyDescriptors

getMappedPropertyDescriptors

getNestedProperty

getProperty

getPropertyDescriptor

getPropertyDescriptors

getPropertyDescriptors

getPropertyEditorClass

getPropertyType

getReadMethod

getSimpleProperty

getWriteMethod

isReadable

isWriteable

setIndexedProperty

setIndexedProperty

setMappedProperty

setMappedProperty

setNestedProperty

setProperty

setSimpleProperty

org.apache.commons.beanutils
Class PropertyUtils