org.apache.commons.beanutils

Class MappedPropertyDescriptor

    • Constructor Summary

      Constructors 
      Constructor and Description
      MappedPropertyDescriptor(java.lang.String propertyName, java.lang.Class beanClass)
      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).
      MappedPropertyDescriptor(java.lang.String propertyName, java.lang.Class beanClass, java.lang.String mappedGetterName, java.lang.String mappedSetterName)
      This constructor takes the name of a mapped property, and method names for reading and writing the property.
      MappedPropertyDescriptor(java.lang.String propertyName, java.lang.reflect.Method mappedGetter, java.lang.reflect.Method mappedSetter)
      This constructor takes the name of a mapped property, and Method objects for reading and writing the property.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Class getMappedPropertyType()
      Gets the Class object for the property values.
      java.lang.reflect.Method getMappedReadMethod()
      Gets the method that should be used to read one of the property value.
      java.lang.reflect.Method getMappedWriteMethod()
      Gets the method that should be used to write one of the property value.
      void setMappedReadMethod(java.lang.reflect.Method mappedGetter)
      Sets the method that should be used to read one of the property value.
      void setMappedWriteMethod(java.lang.reflect.Method mappedSetter)
      Sets the method that should be used to write the property value.
      • Methods inherited from class java.beans.PropertyDescriptor

        createPropertyEditor, equals, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, hashCode, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod
      • Methods inherited from class java.beans.FeatureDescriptor

        attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • MappedPropertyDescriptor

        public MappedPropertyDescriptor(java.lang.String propertyName,
                                java.lang.Class beanClass)
                                 throws java.beans.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:
        java.beans.IntrospectionException - if an exception occurs during introspection.
      • MappedPropertyDescriptor

        public MappedPropertyDescriptor(java.lang.String propertyName,
                                java.lang.Class beanClass,
                                java.lang.String mappedGetterName,
                                java.lang.String mappedSetterName)
                                 throws java.beans.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:
        java.beans.IntrospectionException - if an exception occurs during introspection.
      • MappedPropertyDescriptor

        public MappedPropertyDescriptor(java.lang.String propertyName,
                                java.lang.reflect.Method mappedGetter,
                                java.lang.reflect.Method mappedSetter)
                                 throws java.beans.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:
        java.beans.IntrospectionException - if an exception occurs during introspection.
    • Method Detail

      • getMappedPropertyType

        public java.lang.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 java.lang.reflect.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(java.lang.reflect.Method mappedGetter)
                                 throws java.beans.IntrospectionException
        Sets the method that should be used to read one of the property value.
        Parameters:
        mappedGetter - The mapped getter method.
        Throws:
        java.beans.IntrospectionException - If an error occurs finding the mapped property
      • getMappedWriteMethod

        public java.lang.reflect.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(java.lang.reflect.Method mappedSetter)
                                  throws java.beans.IntrospectionException
        Sets the method that should be used to write the property value.
        Parameters:
        mappedSetter - The mapped setter method.
        Throws:
        java.beans.IntrospectionException - If an error occurs finding the mapped property

Copyright © 2000-2013 The Apache Software Foundation. All Rights Reserved.