org.springframework.beans.PropertyAccessor Maven / Gradle / Ivy
/*
* Copyright 2002-2005 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.beans;
import java.util.Map;
/**
* Common interface for classes that can access bean properties.
* Serves as base interface for BeanWrapper.
*
* @author Juergen Hoeller
* @since 1.1
* @see BeanWrapper
*/
public interface PropertyAccessor {
/**
* Path separator for nested properties.
* Follows normal Java conventions: getFoo().getBar() would be "foo.bar".
*/
String NESTED_PROPERTY_SEPARATOR = ".";
char NESTED_PROPERTY_SEPARATOR_CHAR = '.';
/**
* Marker that indicates the start of a property key for an
* indexed or mapped property like "person.addresses[0]".
*/
String PROPERTY_KEY_PREFIX = "[";
char PROPERTY_KEY_PREFIX_CHAR = '[';
/**
* Marker that indicates the end of a property key for an
* indexed or mapped property like "person.addresses[0]".
*/
String PROPERTY_KEY_SUFFIX = "]";
char PROPERTY_KEY_SUFFIX_CHAR = ']';
/**
* Get the value of a property.
* @param propertyName name of the property to get the value of
* @return the value of the property
* @throws FatalBeanException if there is no such property, if the property
* isn't readable, or if the property getter throws an exception.
*/
Object getPropertyValue(String propertyName) throws BeansException;
/**
* Set a property value. This method is provided for convenience only.
* The setPropertyValue(PropertyValue) method is more powerful.
* @param propertyName name of the property to set value of
* @param value the new value
* @throws FatalBeanException if there is no such property, if the property
* isn't writable, or if the property setter throws an exception.
*/
void setPropertyValue(String propertyName, Object value) throws BeansException;
/**
* Update a property value.
* This is the preferred way to update an individual property.
* @param pv object containing new property value
* @throws FatalBeanException if there is no such property, if the property
* isn't writable, or if the property setter throws an exception.
*/
void setPropertyValue(PropertyValue pv) throws BeansException;
/**
* Perform a bulk update from a Map.
* Bulk updates from PropertyValues are more powerful: This method is
* provided for convenience. Behaviour will be identical to that of
* the setPropertyValues(PropertyValues) method.
* @param map Map to take properties from. Contains property value objects,
* keyed by property name
* @throws FatalBeanException if there is no such property, if the property
* isn't writable, or if the property setter throws an exception.
*/
void setPropertyValues(Map map) throws BeansException;
/**
* The preferred way to perform a bulk update.
*
Note that performing a bulk 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
* PropertyAccessExceptionsException containing all the individual errors.
* This exception can be examined later to see all binding errors.
* Properties that were successfully updated stay changed.
*
Does not allow unknown fields.
* Equivalent to setPropertyValues(pvs, false).
* @param pvs PropertyValues to set on the target object
* @throws FatalBeanException if there is no such property, if the property
* isn't writable, or if the property setter throws an exception.
* @see #setPropertyValues(PropertyValues, boolean)
*/
void setPropertyValues(PropertyValues pvs) throws BeansException;
/**
* Perform a bulk update with full control over behavior.
*
Note that performing a bulk 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
* PropertyAccessExceptionsException containing all the individual errors.
* This exception can be examined later to see all binding errors.
* Properties that were successfully updated stay changed.
*
Does not allow unknown fields.
* @param pvs PropertyValues to set on the target object
* @param ignoreUnknown should we ignore unknown values (not found in the bean)
* @throws FatalBeanException if there is no such property, if the property
* isn't writable, or if the property setter throws an exception.
*/
void setPropertyValues(PropertyValues pvs, boolean ignoreUnknown)
throws BeansException;
}