Class MappedPropertyDescriptor

java.lang.Object
java.beans.FeatureDescriptor
java.beans.PropertyDescriptor
org.apache.commons.beanutils.MappedPropertyDescriptor

public class MappedPropertyDescriptor extends PropertyDescriptor
A MappedPropertyDescriptor describes one mapped property. Mapped properties are multivalued properties like indexed properties but that are accessed with a String key instead of an index. Such property values are typically stored in a Map collection. For this class to work properly, a mapped value must have getter and setter methods of the form

getProperty(String key) and

setProperty(String key, Object value),

where Property must be replaced by the name of the property.

Version:
$Id$
See Also:
  • Field Details

    • mappedPropertyTypeRef

      private Reference<Class<?>> mappedPropertyTypeRef
      The underlying data type of the property we are describing.
    • mappedReadMethodRef

      The reader method for this property (if any).
    • mappedWriteMethodRef

      private MappedPropertyDescriptor.MappedMethodReference mappedWriteMethodRef
      The writer method for this property (if any).
    • STRING_CLASS_PARAMETER

      private static final Class<?>[] STRING_CLASS_PARAMETER
      The parameter types array for the reader method signature.
  • Constructor Details

    • MappedPropertyDescriptor

      public MappedPropertyDescriptor(String propertyName, Class<?> beanClass) throws IntrospectionException
      Constructs a MappedPropertyDescriptor for a property that follows the standard Java convention by having getFoo and setFoo accessor methods, with the addition of a String parameter (the key). Thus if the argument name is "fred", it will assume that the writer method is "setFred" and the reader method is "getFred". Note that the property name should start with a lower case character, which will be capitalized in the method names.
      Parameters:
      propertyName - The programmatic name of the property.
      beanClass - The Class object for the target bean. For example sun.beans.OurButton.class.
      Throws:
      IntrospectionException - if an exception occurs during introspection.
    • MappedPropertyDescriptor

      public MappedPropertyDescriptor(String propertyName, Class<?> beanClass, String mappedGetterName, String mappedSetterName) throws IntrospectionException
      This constructor takes the name of a mapped property, and method names for reading and writing the property.
      Parameters:
      propertyName - The programmatic name of the property.
      beanClass - The Class object for the target bean. For example sun.beans.OurButton.class.
      mappedGetterName - The name of the method used for reading one of the property values. May be null if the property is write-only.
      mappedSetterName - The name of the method used for writing one of the property values. May be null if the property is read-only.
      Throws:
      IntrospectionException - if an exception occurs during introspection.
    • MappedPropertyDescriptor

      public MappedPropertyDescriptor(String propertyName, Method mappedGetter, Method mappedSetter) throws IntrospectionException
      This constructor takes the name of a mapped property, and Method objects for reading and writing the property.
      Parameters:
      propertyName - The programmatic name of the property.
      mappedGetter - The method used for reading one of the property values. May be be null if the property is write-only.
      mappedSetter - The method used for writing one the property values. May be null if the property is read-only.
      Throws:
      IntrospectionException - if an exception occurs during introspection.
  • Method Details

    • getMappedPropertyType

      public Class<?> getMappedPropertyType()
      Gets the Class object for the property values.
      Returns:
      The Java type info for the property values. Note that the "Class" object may describe a built-in Java type such as "int". The result may be "null" if this is a mapped property that does not support non-keyed access.

      This is the type that will be returned by the mappedReadMethod.

    • getMappedReadMethod

      public Method getMappedReadMethod()
      Gets the method that should be used to read one of the property value.
      Returns:
      The method that should be used to read the property value. May return null if the property can't be read.
    • setMappedReadMethod

      public void setMappedReadMethod(Method mappedGetter) throws IntrospectionException
      Sets the method that should be used to read one of the property value.
      Parameters:
      mappedGetter - The mapped getter method.
      Throws:
      IntrospectionException - If an error occurs finding the mapped property
    • getMappedWriteMethod

      public Method getMappedWriteMethod()
      Gets the method that should be used to write one of the property value.
      Returns:
      The method that should be used to write one of the property value. May return null if the property can't be written.
    • setMappedWriteMethod

      public void setMappedWriteMethod(Method mappedSetter) throws IntrospectionException
      Sets the method that should be used to write the property value.
      Parameters:
      mappedSetter - The mapped setter method.
      Throws:
      IntrospectionException - If an error occurs finding the mapped property
    • findMappedPropertyType

      private void findMappedPropertyType() throws IntrospectionException
      Introspect our bean class to identify the corresponding getter and setter methods.
      Throws:
      IntrospectionException
    • capitalizePropertyName

      private static String capitalizePropertyName(String s)
      Return a capitalized version of the specified property name.
      Parameters:
      s - The property name
    • internalGetMethod

      private static Method internalGetMethod(Class<?> initial, String methodName, int parameterCount)
      Find a method on a class with a specified number of parameters.
    • getMethod

      private static Method getMethod(Class<?> clazz, String methodName, int parameterCount) throws IntrospectionException
      Find a method on a class with a specified number of parameters.
      Throws:
      IntrospectionException
    • getMethod

      private static Method getMethod(Class<?> clazz, String methodName, Class<?>[] parameterTypes) throws IntrospectionException
      Find a method on a class with a specified parameter list.
      Throws:
      IntrospectionException