Open Source Repository

Home /spring/spring-beans-3.0.5 | Repository Home


org/springframework/beans/PropertyValue.java
/*
 * Copyright 2002-2009 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.beans.PropertyDescriptor;
import java.io.Serializable;

import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;

/**
 * Object to hold information and value for an individual bean 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 an optimized way.
 *
 <p>Note that the value doesn't need to be the final required type:
 * A {@link 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 BeanMetadataAttributeAccessor implements Serializable {

  private final String name;

  private final Object value;

  private Object source;

  private boolean optional = false;

  private boolean converted = false;

  private Object convertedValue;

  /** Package-visible field that indicates whether conversion is necessary */
  volatile Boolean conversionNecessary;

  /** Package-visible field for caching the resolved property path tokens */
  volatile Object resolvedTokens;

  /** Package-visible field for caching the resolved PropertyDescriptor */
  volatile PropertyDescriptor resolvedDescriptor;


  /**
   * Create a new PropertyValue instance.
   @param name the name of the property (never <code>null</code>)
   @param value the value of the property (possibly before type conversion)
   */
  public PropertyValue(String name, Object value) {
    this.name = name;
    this.value = value;
  }

  /**
   * Copy constructor.
   @param original the PropertyValue to copy (never <code>null</code>)
   */
  public PropertyValue(PropertyValue original) {
    Assert.notNull(original, "Original must not be null");
    this.name = original.getName();
    this.value = original.getValue();
    this.source = original.getSource();
    this.optional = original.isOptional();
    this.converted = original.converted;
    this.convertedValue = original.convertedValue;
    this.conversionNecessary = original.conversionNecessary;
    this.resolvedTokens = original.resolvedTokens;
    this.resolvedDescriptor = original.resolvedDescriptor;
    copyAttributesFrom(original);
  }

  /**
   * Constructor that exposes a new value for an original value holder.
   * The original holder will be exposed as source of the new holder.
   @param original the PropertyValue to link to (never <code>null</code>)
   @param newValue the new value to apply
   */
  public PropertyValue(PropertyValue original, Object newValue) {
    Assert.notNull(original, "Original must not be null");
    this.name = original.getName();
    this.value = newValue;
    this.source = original;
    this.optional = original.isOptional();
    this.conversionNecessary = original.conversionNecessary;
    this.resolvedTokens = original.resolvedTokens;
    this.resolvedDescriptor = original.resolvedDescriptor;
    copyAttributesFrom(original);
  }


  /**
   * Return the name of the property.
   */
  public String getName() {
    return this.name;
  }

  /**
   * Return the value of the property.
   <p>Note that type conversion will <i>not</i> have occurred here.
   * It is the responsibility of the BeanWrapper implementation to
   * perform type conversion.
   */
  public Object getValue() {
    return this.value;
  }

  /**
   * Return the original PropertyValue instance for this value holder.
   @return the original PropertyValue (either a source of this
   * value holder or this value holder itself).
   */
  public PropertyValue getOriginalPropertyValue() {
    PropertyValue original = this;
    while (original.source instanceof PropertyValue && original.source != original) {
      original = (PropertyValueoriginal.source;
    }
    return original;
  }

  public void setOptional(boolean optional) {
    this.optional = optional;
  }

  public boolean isOptional() {
    return this.optional;
  }

  /**
   * Return whether this holder contains a converted value already (<code>true</code>),
   * or whether the value still needs to be converted (<code>false</code>).
   */
  public synchronized boolean isConverted() {
    return this.converted;
  }

  /**
   * Set the converted value of the constructor argument,
   * after processed type conversion.
   */
  public synchronized void setConvertedValue(Object value) {
    this.converted = true;
    this.convertedValue = value;
  }

  /**
   * Return the converted value of the constructor argument,
   * after processed type conversion.
   */
  public synchronized Object getConvertedValue() {
    return this.convertedValue;
  }


  @Override
  public boolean equals(Object other) {
    if (this == other) {
      return true;
    }
    if (!(other instanceof PropertyValue)) {
      return false;
    }
    PropertyValue otherPv = (PropertyValueother;
    return (this.name.equals(otherPv.name&&
        ObjectUtils.nullSafeEquals(this.value, otherPv.value&&
        ObjectUtils.nullSafeEquals(this.source, otherPv.source));
  }

  @Override
  public int hashCode() {
    return this.name.hashCode() 29 + ObjectUtils.nullSafeHashCode(this.value);
  }

  @Override
  public String toString() {
    return "bean property '" this.name + "'";
  }

}