org.springframework.beans

类 AbstractNestablePropertyAccessor

java.lang.Object

org.springframework.beans.PropertyEditorRegistrySupport

org.springframework.beans.TypeConverterSupport

org.springframework.beans.AbstractPropertyAccessor

org.springframework.beans.AbstractNestablePropertyAccessor

所有已实现的接口:

ConfigurablePropertyAccessor, PropertyAccessor, PropertyEditorRegistry, TypeConverter

直接已知子类:

BeanWrapperImpl, DirectFieldAccessor

public abstract class AbstractNestablePropertyAccessor
extends AbstractPropertyAccessor

A basic ConfigurablePropertyAccessor that provides the necessary infrastructure for all typical use cases.

This accessor will convert collection and array values to the corresponding target collections or arrays, if necessary. Custom property editors that deal with collections or arrays can either be written via PropertyEditor's setValue, or against a comma-delimited String via setAsText, as String arrays are converted in such a format if the array itself is not assignable.

从以下版本开始:

4.2

作者:

Juergen Hoeller, Stephane Nicoll, Rod Johnson, Rob Harrop

另请参阅:

PropertyEditorRegistrySupport.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor), AbstractPropertyAccessor.setPropertyValues(java.util.Map<?, ?>), setPropertyValue(java.lang.String, java.lang.Object), getPropertyValue(java.lang.String), getPropertyType(java.lang.String), BeanWrapper, PropertyEditorRegistrySupport

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	AbstractNestablePropertyAccessor.PropertyHandler A handler for a specific property.
protected static class	AbstractNestablePropertyAccessor.PropertyTokenHolder Holder class used to store property tokens.

字段概要

从接口继承的字段 org.springframework.beans.PropertyAccessor

NESTED_PROPERTY_SEPARATOR, NESTED_PROPERTY_SEPARATOR_CHAR, PROPERTY_KEY_PREFIX, PROPERTY_KEY_PREFIX_CHAR, PROPERTY_KEY_SUFFIX, PROPERTY_KEY_SUFFIX_CHAR

构造器概要

构造器

限定符	构造器和说明
protected	AbstractNestablePropertyAccessor() Create a new empty accessor.
protected	AbstractNestablePropertyAccessor(boolean registerDefaultEditors) Create a new empty accessor.
protected	AbstractNestablePropertyAccessor(Class<?> clazz) Create a new accessor, wrapping a new instance of the specified class.
protected	AbstractNestablePropertyAccessor(Object object) Create a new accessor for the given object.
protected	AbstractNestablePropertyAccessor(Object object, String nestedPath, AbstractNestablePropertyAccessor parent) Create a new accessor for the given object, registering a nested path that the object is in.
protected	AbstractNestablePropertyAccessor(Object object, String nestedPath, Object rootObject) Create a new accessor for the given object, registering a nested path that the object is in.

方法概要

限定符和类型	方法和说明
protected Object	convertForProperty(String propertyName, Object oldValue, Object newValue, org.springframework.core.convert.TypeDescriptor td)
protected abstract NotWritablePropertyException	createNotWritablePropertyException(String propertyName) Create a NotWritablePropertyException for the specified property.
int	getAutoGrowCollectionLimit() Return the limit for array and collection auto-growing.
protected String	getFinalPath(AbstractNestablePropertyAccessor pa, String nestedPath) Get the last component of the path.
protected abstract AbstractNestablePropertyAccessor.PropertyHandler	getLocalPropertyHandler(String propertyName) Return a AbstractNestablePropertyAccessor.PropertyHandler for the specified local propertyName.
String	getNestedPath() Return the nested path of the object wrapped by this accessor.
protected AbstractNestablePropertyAccessor	getPropertyAccessorForPropertyPath(String propertyPath) Recursively navigate to return a property accessor for the nested property path.
protected AbstractNestablePropertyAccessor.PropertyHandler	getPropertyHandler(String propertyName) Return the AbstractNestablePropertyAccessor.PropertyHandler for the specified propertyName, navigating if necessary.
Class<?>	getPropertyType(String propertyName) Determine the property type for the given property path.
org.springframework.core.convert.TypeDescriptor	getPropertyTypeDescriptor(String propertyName) Return a type descriptor for the specified property: preferably from the read method, falling back to the write method.
protected Object	getPropertyValue(AbstractNestablePropertyAccessor.PropertyTokenHolder tokens)
Object	getPropertyValue(String propertyName) Actually get the value of a property.
Class<?>	getRootClass() Return the class of the root object at the top of the path of this accessor.
Object	getRootInstance() Return the root object at the top of the path of this accessor.
Class<?>	getWrappedClass()
Object	getWrappedInstance()
boolean	isReadableProperty(String propertyName) Determine whether the specified property is readable.
boolean	isWritableProperty(String propertyName) Determine whether the specified property is writable.
protected abstract AbstractNestablePropertyAccessor	newNestedPropertyAccessor(Object object, String nestedPath) Create a new nested property accessor instance.
void	setAutoGrowCollectionLimit(int autoGrowCollectionLimit) Specify a limit for array and collection auto-growing.
protected void	setPropertyValue(AbstractNestablePropertyAccessor.PropertyTokenHolder tokens, PropertyValue pv)
void	setPropertyValue(PropertyValue pv) Set the specified value as current property value.
void	setPropertyValue(String propertyName, Object value) Actually set a property value.
void	setWrappedInstance(Object object) Switch the target object, replacing the cached introspection results only if the class of the new object is different to that of the replaced object.
void	setWrappedInstance(Object object, String nestedPath, Object rootObject) Switch the target object, replacing the cached introspection results only if the class of the new object is different to that of the replaced object.
String	toString()

从类继承的方法 org.springframework.beans.AbstractPropertyAccessor

isAutoGrowNestedPaths, isExtractOldValueForEditor, setAutoGrowNestedPaths, setExtractOldValueForEditor, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues

从类继承的方法 org.springframework.beans.TypeConverterSupport

convertIfNecessary, convertIfNecessary, convertIfNecessary

从类继承的方法 org.springframework.beans.PropertyEditorRegistrySupport

copyCustomEditorsTo, copyDefaultEditorsTo, findCustomEditor, getConversionService, getDefaultEditor, guessPropertyTypeFromEditors, hasCustomEditorForElement, overrideDefaultEditor, registerCustomEditor, registerCustomEditor, registerDefaultEditors, setConversionService, useConfigValueEditors

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.springframework.beans.ConfigurablePropertyAccessor

getConversionService, setConversionService

从接口继承的方法 org.springframework.beans.PropertyEditorRegistry

findCustomEditor, registerCustomEditor, registerCustomEditor

从接口继承的方法 org.springframework.beans.TypeConverter

convertIfNecessary, convertIfNecessary, convertIfNecessary

构造器详细资料

AbstractNestablePropertyAccessor

protected AbstractNestablePropertyAccessor()

Create a new empty accessor. Wrapped instance needs to be set afterwards. Registers default editors.

另请参阅:

setWrappedInstance(java.lang.Object)

AbstractNestablePropertyAccessor

protected AbstractNestablePropertyAccessor(boolean registerDefaultEditors)

Create a new empty accessor. Wrapped instance needs to be set afterwards.

参数:

registerDefaultEditors - whether to register default editors (can be suppressed if the accessor won't need any type conversion)

另请参阅:

setWrappedInstance(java.lang.Object)

AbstractNestablePropertyAccessor

protected AbstractNestablePropertyAccessor(Object object)

Create a new accessor for the given object.

参数:

object - object wrapped by this accessor

AbstractNestablePropertyAccessor

protected AbstractNestablePropertyAccessor(Class<?> clazz)

Create a new accessor, wrapping a new instance of the specified class.

参数:

clazz - class to instantiate and wrap

AbstractNestablePropertyAccessor

protected AbstractNestablePropertyAccessor(Object object,
                                           String nestedPath,
                                           Object rootObject)

Create a new accessor for the given object, registering a nested path that the object is in.

参数:

object - object wrapped by this accessor

nestedPath - the nested path of the object

rootObject - the root object at the top of the path

AbstractNestablePropertyAccessor

protected AbstractNestablePropertyAccessor(Object object,
                                           String nestedPath,
                                           AbstractNestablePropertyAccessor parent)

Create a new accessor for the given object, registering a nested path that the object is in.

参数:

object - object wrapped by this accessor

nestedPath - the nested path of the object

parent - the containing accessor (must not be null)

方法详细资料

setAutoGrowCollectionLimit

public void setAutoGrowCollectionLimit(int autoGrowCollectionLimit)

Specify a limit for array and collection auto-growing.

Default is unlimited on a plain accessor.

getAutoGrowCollectionLimit

public int getAutoGrowCollectionLimit()

Return the limit for array and collection auto-growing.

setWrappedInstance

public void setWrappedInstance(Object object)

Switch the target object, replacing the cached introspection results only if the class of the new object is different to that of the replaced object.

参数:

object - the new target object

setWrappedInstance

public void setWrappedInstance(Object object,
                               @Nullable
                               String nestedPath,
                               @Nullable
                               Object rootObject)

Switch the target object, replacing the cached introspection results only if the class of the new object is different to that of the replaced object.

参数:

object - the new target object

nestedPath - the nested path of the object

rootObject - the root object at the top of the path

getWrappedInstance

public final Object getWrappedInstance()

getWrappedClass

public final Class<?> getWrappedClass()

getNestedPath

public final String getNestedPath()

Return the nested path of the object wrapped by this accessor.

getRootInstance

public final Object getRootInstance()

Return the root object at the top of the path of this accessor.

另请参阅:

getNestedPath()

getRootClass

public final Class<?> getRootClass()

Return the class of the root object at the top of the path of this accessor.

另请参阅:

getNestedPath()

setPropertyValue

public void setPropertyValue(String propertyName,
                             @Nullable
                             Object value)
                      throws BeansException

从类复制的说明: AbstractPropertyAccessor

Actually set a property value.

指定者:

setPropertyValue 在接口中 PropertyAccessor

指定者:

setPropertyValue 在类中 AbstractPropertyAccessor

参数:

propertyName - name of the property to set value of

value - the new value

抛出:

InvalidPropertyException - if there is no such property or if the property isn't writable

PropertyAccessException - if the property was valid but the accessor method failed or a type mismatch occurred

BeansException

setPropertyValue

public void setPropertyValue(PropertyValue pv)
                      throws BeansException

从接口复制的说明: PropertyAccessor

Set the specified value as current property value.

指定者:

setPropertyValue 在接口中 PropertyAccessor

覆盖:

setPropertyValue 在类中 AbstractPropertyAccessor

参数:

pv - an object containing the new property value

抛出:

InvalidPropertyException - if there is no such property or if the property isn't writable

PropertyAccessException - if the property was valid but the accessor method failed or a type mismatch occurred

BeansException

setPropertyValue

protected void setPropertyValue(AbstractNestablePropertyAccessor.PropertyTokenHolder tokens,
                                PropertyValue pv)
                         throws BeansException

抛出:

BeansException

getPropertyType

@Nullable
public Class<?> getPropertyType(String propertyName)
                                    throws BeansException

从类复制的说明: PropertyEditorRegistrySupport

Determine the property type for the given property path.

Called by PropertyEditorRegistrySupport.findCustomEditor(java.lang.Class<?>, java.lang.String) if no required type has been specified, to be able to find a type-specific editor even if just given a property path.

The default implementation always returns null. BeanWrapperImpl overrides this with the standard getPropertyType method as defined by the BeanWrapper interface.

指定者:

getPropertyType 在接口中 PropertyAccessor

覆盖:

getPropertyType 在类中 AbstractPropertyAccessor

参数:

propertyName - the property path to determine the type for

返回:

the type of the property, or null if not determinable

抛出:

PropertyAccessException - if the property was valid but the accessor method failed

BeansException

另请参阅:

PropertyAccessor.getPropertyType(String)

getPropertyTypeDescriptor

@Nullable
public org.springframework.core.convert.TypeDescriptor getPropertyTypeDescriptor(String propertyName)
                                                                                     throws BeansException

从接口复制的说明: PropertyAccessor

Return a type descriptor for the specified property: preferably from the read method, falling back to the write method.

参数:

propertyName - the property to check (may be a nested path and/or an indexed/mapped property)

返回:

the property type for the particular property, or null if not determinable

抛出:

PropertyAccessException - if the property was valid but the accessor method failed

BeansException

isReadableProperty

public boolean isReadableProperty(String propertyName)

从接口复制的说明: PropertyAccessor

Determine whether the specified property is readable.

Returns false if the property doesn't exist.

参数:

propertyName - the property to check (may be a nested path and/or an indexed/mapped property)

返回:

whether the property is readable

isWritableProperty

public boolean isWritableProperty(String propertyName)

从接口复制的说明: PropertyAccessor

Determine whether the specified property is writable.

Returns false if the property doesn't exist.

参数:

propertyName - the property to check (may be a nested path and/or an indexed/mapped property)

返回:

whether the property is writable

convertForProperty

@Nullable
protected Object convertForProperty(String propertyName,
                                               @Nullable
                                               Object oldValue,
                                               @Nullable
                                               Object newValue,
                                               org.springframework.core.convert.TypeDescriptor td)
                                        throws TypeMismatchException

抛出:

TypeMismatchException

getPropertyValue

@Nullable
public Object getPropertyValue(String propertyName)
                                   throws BeansException

从类复制的说明: AbstractPropertyAccessor

Actually get the value of a property.

指定者:

getPropertyValue 在接口中 PropertyAccessor

指定者:

getPropertyValue 在类中 AbstractPropertyAccessor

参数:

propertyName - name of the property to get the value of

返回:

the value of the property

抛出:

InvalidPropertyException - if there is no such property or if the property isn't readable

PropertyAccessException - if the property was valid but the accessor method failed

BeansException

getPropertyValue

@Nullable
protected Object getPropertyValue(AbstractNestablePropertyAccessor.PropertyTokenHolder tokens)
                                      throws BeansException

抛出:

BeansException

getPropertyHandler

@Nullable
protected AbstractNestablePropertyAccessor.PropertyHandler getPropertyHandler(String propertyName)
                                                                                  throws BeansException

Return the AbstractNestablePropertyAccessor.PropertyHandler for the specified propertyName, navigating if necessary. Return null if not found rather than throwing an exception.

参数:

propertyName - the property to obtain the descriptor for

返回:

the property descriptor for the specified property, or null if not found

抛出:

BeansException - in case of introspection failure

getLocalPropertyHandler

@Nullable
protected abstract AbstractNestablePropertyAccessor.PropertyHandler getLocalPropertyHandler(String propertyName)

Return a AbstractNestablePropertyAccessor.PropertyHandler for the specified local propertyName. Only used to reach a property available in the current context.

参数:

propertyName - the name of a local property

返回:

the handler for that property, or null if it has not been found

newNestedPropertyAccessor

protected abstract AbstractNestablePropertyAccessor newNestedPropertyAccessor(Object object,
                                                                              String nestedPath)

Create a new nested property accessor instance. Can be overridden in subclasses to create a PropertyAccessor subclass.

参数:

object - object wrapped by this PropertyAccessor

nestedPath - the nested path of the object

返回:

the nested PropertyAccessor instance

createNotWritablePropertyException

protected abstract NotWritablePropertyException createNotWritablePropertyException(String propertyName)

Create a NotWritablePropertyException for the specified property.

getFinalPath

protected String getFinalPath(AbstractNestablePropertyAccessor pa,
                              String nestedPath)

Get the last component of the path. Also works if not nested.

参数:

pa - property accessor to work on

nestedPath - property path we know is nested

返回:

last component of the path (the property on the target bean)

getPropertyAccessorForPropertyPath

protected AbstractNestablePropertyAccessor getPropertyAccessorForPropertyPath(String propertyPath)

Recursively navigate to return a property accessor for the nested property path.

参数:

propertyPath - property path, which may be nested

返回:

a property accessor for the target bean

toString

public String toString()

覆盖:

toString 在类中 Object