org.springframework.beans.PropertyValue Maven / Gradle / Ivy
/*
* Copyright 2002-2006 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.io.Serializable;
import org.springframework.core.AttributeAccessorSupport;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
/**
* Class to hold information and value for an individual property.
* Using an object here, rather than just storing all properties in a
* map keyed by property name, allows for more flexibility, and the
* ability to handle indexed properties etc in a special way if necessary.
*
* Note that the value doesn't need to be the final required type:
* A BeanWrapper implementation should handle any necessary conversion, as
* this object doesn't know anything about the objects it will be applied to.
*
* @author Rod Johnson
* @author Rob Harrop
* @author Juergen Hoeller
* @since 13 May 2001
* @see PropertyValues
* @see BeanWrapper
*/
public class PropertyValue extends AttributeAccessorSupport implements BeanMetadataElement, Serializable {
private final String name;
private final Object value;
private Object source;
/**
* Create a new PropertyValue instance.
* @param name name of the property
* @param value value of the property (possibly before type conversion)
*/
public PropertyValue(String name, Object value) {
if (name == null) {
throw new IllegalArgumentException("Property name cannot be null");
}
this.name = name;
this.value = value;
}
/**
* Copy constructor.
* @param original the PropertyValue to copy
*/
public PropertyValue(PropertyValue original) {
Assert.notNull(original, "Original must not be null");
this.name = original.getName();
this.value = original.getValue();
this.source = original.getSource();
copyAttributesFrom(original);
}
/**
* Return the name of the property.
*/
public String getName() {
return name;
}
/**
* Return the value of the property.
*
Note that type conversion will not have occurred here.
* It is the responsibility of the BeanWrapper implementation to
* perform type conversion.
*/
public Object getValue() {
return value;
}
/**
* Set the configuration source Object for this metadata element.
*
The exact type of the object will depend on the configuration mechanism used.
*/
public void setSource(Object source) {
this.source = source;
}
public Object getSource() {
return source;
}
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (!(other instanceof PropertyValue)) {
return false;
}
PropertyValue otherPv = (PropertyValue) other;
return (this.name.equals(otherPv.name) &&
ObjectUtils.nullSafeEquals(this.value, otherPv.value) &&
ObjectUtils.nullSafeEquals(this.source, otherPv.source));
}
public int hashCode() {
return this.name.hashCode() * 29 + (this.value == null ? 0 : this.value.hashCode());
}
public String toString() {
return "PropertyValue: name='" + this.name + "', value=[" + this.value + "]";
}
}