Top Description Methods
org.springframework.beans

public Interface BeanWrapper

extends ConfigurablePropertyAccessor
Known Direct Implementers
org.springframework.beans.BeanWrapperImpl
Imports
java.beans.PropertyDescriptor

The central interface of Spring's low-level JavaBeans infrastructure.

Typically not used directly but rather implicitly via a org.springframework.beans.factory.BeanFactory or a org.springframework.validation.DataBinder.

Provides operations to analyze and manipulate standard JavaBeans: the ability to get and set property values (individually or in bulk), get property descriptors, and query the readability/writability of properties.

This interface supports nested properties enabling the setting of properties on subproperties to an unlimited depth.

A BeanWrapper's default for the "extractOldValueForEditor" setting is "false", to avoid side effects caused by getter method invocations. Turn this to "true" to expose present property values to custom editors.

Authors
Rod Johnson, Juergen Hoeller
Since
13 April 2001
See Also
PropertyAccessor, PropertyEditorRegistry, PropertyAccessorFactory#forBeanPropertyAccess, org.springframework.beans.factory.BeanFactory, org.springframework.validation.BeanPropertyBindingResult, org.springframework.validation.DataBinder#initBeanPropertyAccess()

Method Summary

Modifier and TypeMethod and Description
public int
getAutoGrowCollectionLimit()

Return the limit for array and collection auto-growing.

public PropertyDescriptor

Returns:

the property descriptor for the specified property
getPropertyDescriptor
(String
the property to obtain the descriptor for (may be a nested path, but not an indexed/mapped property)
propertyName
)

Obtain the property descriptor for a specific property of the wrapped object.

public PropertyDescriptor[]

Returns:

the PropertyDescriptors for the wrapped object
getPropertyDescriptors
()

Obtain the PropertyDescriptors for the wrapped object (as determined by standard JavaBeans introspection).

public Class<?>
getWrappedClass()

Return the type of the wrapped bean instance.

public Object
getWrappedInstance()

Return the bean instance wrapped by this object.

public void
setAutoGrowCollectionLimit(int autoGrowCollectionLimit)

Specify a limit for array and collection auto-growing.

Inherited from org.springframework.beans.ConfigurablePropertyAccessor:
getConversionServiceisAutoGrowNestedPathsisExtractOldValueForEditorsetAutoGrowNestedPathssetConversionServicesetExtractOldValueForEditor

Method Detail

getAutoGrowCollectionLimitback to summary
public int getAutoGrowCollectionLimit()

Return the limit for array and collection auto-growing.

Since
4.1
getPropertyDescriptorback to summary
public PropertyDescriptor getPropertyDescriptor(String propertyName) throws InvalidPropertyException

Obtain the property descriptor for a specific property of the wrapped object.

Parameters
propertyName:String

the property to obtain the descriptor for (may be a nested path, but not an indexed/mapped property)

Returns:PropertyDescriptor

the property descriptor for the specified property

Exceptions
InvalidPropertyException:
if there is no such property
getPropertyDescriptorsback to summary
public PropertyDescriptor[] getPropertyDescriptors()

Obtain the PropertyDescriptors for the wrapped object (as determined by standard JavaBeans introspection).

Returns:PropertyDescriptor[]

the PropertyDescriptors for the wrapped object

getWrappedClassback to summary
public Class<?> getWrappedClass()

Return the type of the wrapped bean instance.

getWrappedInstanceback to summary
public Object getWrappedInstance()

Return the bean instance wrapped by this object.

setAutoGrowCollectionLimitback to summary
public void setAutoGrowCollectionLimit(int autoGrowCollectionLimit)

Specify a limit for array and collection auto-growing.

Default is unlimited on a plain BeanWrapper.

Since
4.1