| org.springframework.beans.PropertyAccessor
| PropertyAccessor | | public interface PropertyAccessor (Code) | | Common interface for classes that can access named properties
(such as bean properties of an object or fields in an object)
Serves as base interface for
BeanWrapper .
author:
Juergen Hoeller
since:
1.1
See Also: BeanWrapper |
| Method Summary | |
| Class | getPropertyType(String propertyName)
Determine the property type for the specified property,
either checking the property descriptor or checking the value
in case of an indexed or mapped element. | | Object | getPropertyValue(String propertyName)
Get the current value of the specified property. | | boolean | isReadableProperty(String propertyName)
Determine whether the specified property is readable. | | boolean | isWritableProperty(String propertyName)
Determine whether the specified property is writable. | | void | setPropertyValue(String propertyName, Object value)
Set the specified value as current property value. | | void | setPropertyValue(PropertyValue pv)
Set the specified value as current property value. | | void | setPropertyValues(Map map)
Perform a batch update from a Map.
Bulk updates from PropertyValues are more powerful: This method is
provided for convenience. | | void | setPropertyValues(PropertyValues pvs)
The preferred way to perform a batch update.
Note that performing a batch update differs from performing a single update,
in that an implementation of this class will continue to update properties
if a recoverable error (such as a type mismatch, but not an
invalid field name or the like) is encountered, throwing a
PropertyBatchUpdateException containing all the individual errors.
This exception can be examined later to see all binding errors.
Properties that were successfully updated remain changed.
Does not allow unknown fields or invalid fields.
Parameters:
pvs - PropertyValues to set on the target object
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. | | void | setPropertyValues(PropertyValues pvs, boolean ignoreUnknown)
Perform a batch update with more control over behavior.
Note that performing a batch update differs from performing a single update,
in that an implementation of this class will continue to update properties
if a recoverable error (such as a type mismatch, but not an
invalid field name or the like) is encountered, throwing a
PropertyBatchUpdateException containing all the individual errors.
This exception can be examined later to see all binding errors.
Properties that were successfully updated remain changed.
Parameters:
pvs - PropertyValues to set on the target object
Parameters:
ignoreUnknown - should we ignore unknown properties (not found in the bean)
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. | | void | setPropertyValues(PropertyValues pvs, boolean ignoreUnknown, boolean ignoreInvalid)
Perform a batch update with full control over behavior.
Note that performing a batch update differs from performing a single update,
in that an implementation of this class will continue to update properties
if a recoverable error (such as a type mismatch, but not an
invalid field name or the like) is encountered, throwing a
PropertyBatchUpdateException containing all the individual errors.
This exception can be examined later to see all binding errors.
Properties that were successfully updated remain changed.
Parameters:
pvs - PropertyValues to set on the target object
Parameters:
ignoreUnknown - should we ignore unknown properties (not found in the bean)
Parameters:
ignoreInvalid - should we ignore invalid properties (found but not accessible)
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. |
| NESTED_PROPERTY_SEPARATOR | | String NESTED_PROPERTY_SEPARATOR(Code) | | Path separator for nested properties.
Follows normal Java conventions: getFoo().getBar() would be "foo.bar".
|
| NESTED_PROPERTY_SEPARATOR_CHAR | | char NESTED_PROPERTY_SEPARATOR_CHAR(Code) | | |
| PROPERTY_KEY_PREFIX | | String PROPERTY_KEY_PREFIX(Code) | | Marker that indicates the start of a property key for an
indexed or mapped property like "person.addresses[0]".
|
| PROPERTY_KEY_PREFIX_CHAR | | char PROPERTY_KEY_PREFIX_CHAR(Code) | | |
| PROPERTY_KEY_SUFFIX | | String PROPERTY_KEY_SUFFIX(Code) | | Marker that indicates the end of a property key for an
indexed or mapped property like "person.addresses[0]".
|
| PROPERTY_KEY_SUFFIX_CHAR | | char PROPERTY_KEY_SUFFIX_CHAR(Code) | | |
| getPropertyType | | Class getPropertyType(String propertyName) throws BeansException(Code) | | Determine the property type for the specified property,
either checking the property descriptor or checking the value
in case of an indexed or mapped element.
Parameters:
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
throws:
InvalidPropertyException - if there is no such property orif the property isn't readable
throws:
PropertyAccessException - if the property was valid but theaccessor method failed |
| getPropertyValue | | Object getPropertyValue(String propertyName) throws BeansException(Code) | | Get the current value of the specified property.
Parameters:
propertyName - the name of the property to get the value of(may be a nested path and/or an indexed/mapped property) the value of the property
throws:
InvalidPropertyException - if there is no such property orif the property isn't readable
throws:
PropertyAccessException - if the property was valid but theaccessor method failed |
| isReadableProperty | | boolean isReadableProperty(String propertyName)(Code) | | Determine whether the specified property is readable.
Returns false if the property doesn't exist.
Parameters:
propertyName - the property to check(may be a nested path and/or an indexed/mapped property) whether the property is readable |
| isWritableProperty | | boolean isWritableProperty(String propertyName)(Code) | | Determine whether the specified property is writable.
Returns false if the property doesn't exist.
Parameters:
propertyName - the property to check(may be a nested path and/or an indexed/mapped property) whether the property is writable |
| setPropertyValue | | void setPropertyValue(String propertyName, Object value) throws BeansException(Code) | | Set the specified value as current property value.
Parameters:
propertyName - the name of the property to set the value of(may be a nested path and/or an indexed/mapped property)
Parameters:
value - the new value
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyAccessException - if the property was valid but theaccessor method failed or a type mismatch occured |
| setPropertyValue | | void setPropertyValue(PropertyValue pv) throws BeansException(Code) | | Set the specified value as current property value.
Parameters:
pv - an object containing the new property value
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyAccessException - if the property was valid but theaccessor method failed or a type mismatch occured |
| setPropertyValues | | void setPropertyValues(Map map) throws BeansException(Code) | | Perform a batch update from a Map.
Bulk updates from PropertyValues are more powerful: This method is
provided for convenience. Behavior will be identical to that of
the
PropertyAccessor.setPropertyValues(PropertyValues) method.
Parameters:
map - Map to take properties from. Contains property value objects,keyed by property name
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. This exception bundlesall individual PropertyAccessExceptions. All other properties will have beensuccessfully updated. |
| setPropertyValues | | void setPropertyValues(PropertyValues pvs) throws BeansException(Code) | | The preferred way to perform a batch update.
Note that performing a batch update differs from performing a single update,
in that an implementation of this class will continue to update properties
if a recoverable error (such as a type mismatch, but not an
invalid field name or the like) is encountered, throwing a
PropertyBatchUpdateException containing all the individual errors.
This exception can be examined later to see all binding errors.
Properties that were successfully updated remain changed.
Does not allow unknown fields or invalid fields.
Parameters:
pvs - PropertyValues to set on the target object
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. This exception bundlesall individual PropertyAccessExceptions. All other properties will have beensuccessfully updated.
See Also: PropertyAccessor.setPropertyValues(PropertyValues,boolean,boolean) |
| setPropertyValues | | void setPropertyValues(PropertyValues pvs, boolean ignoreUnknown) throws BeansException(Code) | | Perform a batch update with more control over behavior.
Note that performing a batch update differs from performing a single update,
in that an implementation of this class will continue to update properties
if a recoverable error (such as a type mismatch, but not an
invalid field name or the like) is encountered, throwing a
PropertyBatchUpdateException containing all the individual errors.
This exception can be examined later to see all binding errors.
Properties that were successfully updated remain changed.
Parameters:
pvs - PropertyValues to set on the target object
Parameters:
ignoreUnknown - should we ignore unknown properties (not found in the bean)
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. This exception bundlesall individual PropertyAccessExceptions. All other properties will have beensuccessfully updated.
See Also: PropertyAccessor.setPropertyValues(PropertyValues,boolean,boolean) |
| setPropertyValues | | void setPropertyValues(PropertyValues pvs, boolean ignoreUnknown, boolean ignoreInvalid) throws BeansException(Code) | | Perform a batch update with full control over behavior.
Note that performing a batch update differs from performing a single update,
in that an implementation of this class will continue to update properties
if a recoverable error (such as a type mismatch, but not an
invalid field name or the like) is encountered, throwing a
PropertyBatchUpdateException containing all the individual errors.
This exception can be examined later to see all binding errors.
Properties that were successfully updated remain changed.
Parameters:
pvs - PropertyValues to set on the target object
Parameters:
ignoreUnknown - should we ignore unknown properties (not found in the bean)
Parameters:
ignoreInvalid - should we ignore invalid properties (found but not accessible)
throws:
InvalidPropertyException - if there is no such property orif the property isn't writable
throws:
PropertyBatchUpdateException - if one or more PropertyAccessExceptionsoccured for specific properties during the batch update. This exception bundlesall individual PropertyAccessExceptions. All other properties will have beensuccessfully updated. |
|
|