public class

BeanUtils

extends Object
java.lang.Object
   ↳ org.apache.commons.beanutils.BeanUtils
Known Direct Subclasses

Class Overview

Utility methods for populating JavaBeans properties via reflection.

The implementations are provided by BeanUtilsBean. These static utility methods use the default instance. More sophisticated behaviour can be provided by using a BeanUtilsBean instance.

See Also

Summary

Public Constructors
BeanUtils()
Public Methods
static Object cloneBean(Object bean)

Clone a bean based on the available property getters and setters, even if the bean class itself does not implement Cloneable.

static void copyProperties(Object dest, Object orig)

Copy property values from the origin bean to the destination bean for all cases where the property names are the same.

static void copyProperty(Object bean, String name, Object value)

Copy the specified property value to the specified destination bean, performing any type conversion that is required.

static Map createCache()
Create a cache.
static Map describe(Object bean)

Return the entire set of properties for which the specified bean provides a read method.

static String[] getArrayProperty(Object bean, String name)

Return the value of the specified array property of the specified bean, as a String array.

static boolean getCacheFast(Map map)
Return whether a Map is fast
static int getDebug()
This method is deprecated. BeanUtils now uses commons-logging for all log messages. Use your favorite logging tool to configure logging for this class.
static String getIndexedProperty(Object bean, String name)

Return the value of the specified indexed property of the specified bean, as a String.

static String getIndexedProperty(Object bean, String name, int index)
Return the value of the specified indexed property of the specified bean, as a String.
static String getMappedProperty(Object bean, String name, String key)

Return the value of the specified mapped property of the specified bean, as a String.
static String getMappedProperty(Object bean, String name)

Return the value of the specified indexed property of the specified bean, as a String.
static String getNestedProperty(Object bean, String name)

Return the value of the (possibly nested) property of the specified name, for the specified bean, as a String.

static String getProperty(Object bean, String name)

Return the value of the specified property of the specified bean, no matter which property reference format is used, as a String.

static String getSimpleProperty(Object bean, String name)

Return the value of the specified simple property of the specified bean, converted to a String.

static boolean initCause(Throwable throwable, Throwable cause)
If we're running on JDK 1.4 or later, initialize the cause for the given throwable.
static void populate(Object bean, Map properties)

Populate the JavaBeans properties of the specified bean, based on the specified name/value pairs.

static void setCacheFast(Map map, boolean fast)
Set whether fast on a Map
static void setDebug(int newDebug)
This method is deprecated. BeanUtils now uses commons-logging for all log messages. Use your favorite logging tool to configure logging for this class.
static void setProperty(Object bean, String name, Object value)

Set the specified property value, performing type conversions as required to conform to the type of the destination property.

[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public BeanUtils ()

Public Methods

public static Object cloneBean (Object bean)

Clone a bean based on the available property getters and setters, even if the bean class itself does not implement Cloneable.

For more details see BeanUtilsBean.

Parameters
bean Bean to be cloned
Returns
  • the cloned bean
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InstantiationException if a new instance of the bean's class cannot be instantiated
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static void copyProperties (Object dest, Object orig)

Copy property values from the origin bean to the destination bean for all cases where the property names are the same.

For more details see BeanUtilsBean.

Parameters
dest Destination bean whose properties are modified
orig Origin bean whose properties are retrieved
Throws
IllegalAccessException if the caller does not have access to the property accessor method
IllegalArgumentException if the dest or orig argument is null or if the dest property type is different from the source type and the relevant converter has not been registered.
InvocationTargetException if the property accessor method throws an exception
See Also

public static void copyProperty (Object bean, String name, Object value)

Copy the specified property value to the specified destination bean, performing any type conversion that is required.

For more details see BeanUtilsBean.

Parameters
bean Bean on which setting is to be performed
name Property name (can be nested/indexed/mapped/combo)
value Value to be set
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
See Also

public static Map createCache ()

Create a cache.

Returns
  • a new cache

public static Map describe (Object bean)

Return the entire set of properties for which the specified bean provides a read method.

For more details see BeanUtilsBean.

Parameters
bean Bean whose properties are to be extracted
Returns
  • Map of property descriptors
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String[] getArrayProperty (Object bean, String name)

Return the value of the specified array property of the specified bean, as a String array.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name Name of the property to be extracted
Returns
  • The array property value
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static boolean getCacheFast (Map map)

Return whether a Map is fast

Parameters
map The map
Returns
  • Whether it is fast or not.

public static int getDebug ()

This method is deprecated.
BeanUtils now uses commons-logging for all log messages. Use your favorite logging tool to configure logging for this class.

The debug static property is no longer used

Returns
  • debug property

public static String getIndexedProperty (Object bean, String name)

Return the value of the specified indexed property of the specified bean, as a String.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name propertyname[index] of the property value to be extracted
Returns
  • The indexed property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String getIndexedProperty (Object bean, String name, int index)

Return the value of the specified indexed property of the specified bean, as a String. The index is specified as a method parameter and must *not* be included in the property name expression

For more details see BeanUtilsBean.

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
Returns
  • The indexed property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String getMappedProperty (Object bean, String name, String key)

Return the value of the specified mapped property of the specified bean, as a String.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name Simple property name of the property value to be extracted
key Lookup key of the property value to be extracted
Returns
  • The mapped property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String getMappedProperty (Object bean, String name)

Return the value of the specified indexed property of the specified bean, as a String.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name propertyname(index) of the property value to be extracted
Returns
  • The mapped property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String getNestedProperty (Object bean, String name)

Return the value of the (possibly nested) property of the specified name, for the specified bean, as a String.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name Possibly nested name of the property to be extracted
Returns
  • The nested property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
IllegalArgumentException if a nested reference to a property returns null
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String getProperty (Object bean, String name)

Return the value of the specified property of the specified bean, no matter which property reference format is used, as a String.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name Possibly indexed and/or nested name of the property to be extracted
Returns
  • The property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static String getSimpleProperty (Object bean, String name)

Return the value of the specified simple property of the specified bean, converted to a String.

For more details see BeanUtilsBean.

Parameters
bean Bean whose property is to be extracted
name Name of the property to be extracted
Returns
  • The property's value, converted to a String
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
NoSuchMethodException if an accessor method for this property cannot be found
See Also

public static boolean initCause (Throwable throwable, Throwable cause)

If we're running on JDK 1.4 or later, initialize the cause for the given throwable.

Parameters
throwable The throwable.
cause The cause of the throwable.
Returns
  • true if the cause was initialized, otherwise false.

public static void populate (Object bean, Map properties)

Populate the JavaBeans properties of the specified bean, based on the specified name/value pairs.

For more details see BeanUtilsBean.

Parameters
bean JavaBean whose properties are being populated
properties Map keyed by property name, with the corresponding (String or String[]) value(s) to be set
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
See Also

public static void setCacheFast (Map map, boolean fast)

Set whether fast on a Map

Parameters
map The map
fast Whether it should be fast or not.

public static void setDebug (int newDebug)

This method is deprecated.
BeanUtils now uses commons-logging for all log messages. Use your favorite logging tool to configure logging for this class.

The debug static property is no longer used

Parameters
newDebug debug property

public static void setProperty (Object bean, String name, Object value)

Set the specified property value, performing type conversions as required to conform to the type of the destination property.

For more details see BeanUtilsBean.

Parameters
bean Bean on which setting is to be performed
name Property name (can be nested/indexed/mapped/combo)
value Value to be set
Throws
IllegalAccessException if the caller does not have access to the property accessor method
InvocationTargetException if the property accessor method throws an exception
See Also