PropertyUtils (Bean Introspection Utilities (Version 1.7))

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.

The implementations for these methods are provided by PropertyUtilsBean. For more details see PropertyUtilsBean.

Version:: $Revision: 1.42.2.1 $ $Date: 2004/07/27 21:31:00 $
Author:: Craig R. McClanahan, Ralph Schaer, Chris Audley, Rey François, Gregor Raıman, Jan Sorensen, Scott Sanders
See Also:: PropertyUtilsBean

Field Summary

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

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.

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 FastHashMap getMappedPropertyDescriptors(java.lang.Class beanClass)
          Deprecated. This method should not be exposed

static FastHashMap getMappedPropertyDescriptors(java.lang.Object bean)
          Deprecated. This method should not be exposed

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)
          Sets 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)
          Sets 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)
          Sets 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)
          Sets 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)
          Sets 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.

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.