Class IndexedPropertyDescriptor

java.lang.Object
java.beans.FeatureDescriptor
java.beans.PropertyDescriptor
java.beans.IndexedPropertyDescriptor
public class IndexedPropertyDescriptor extends PropertyDescriptor
An IndexedPropertyDescriptor describes a property that acts like an array and has an indexed read and/or indexed write method to access specific elements of the array.

An indexed property may also provide simple non-indexed read and write methods. If these are present, they read and write arrays of the type returned by the indexed read method.

Since:
1.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexedPropertyDescriptor(String propertyName, Class<?> beanClass)
    This constructor constructs an IndexedPropertyDescriptor for a property that follows the standard Java conventions by having getFoo and setFoo accessor methods, for both indexed access and array access.
    IndexedPropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName, String indexedReadMethodName, String indexedWriteMethodName)
    This constructor takes the name of a simple property, and method names for reading and writing the property, both indexed and non-indexed.
    IndexedPropertyDescriptor(String propertyName, Method readMethod, Method writeMethod, Method indexedReadMethod, Method indexedWriteMethod)
    This constructor takes the name of a simple property, and Method objects for reading and writing the property.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Compares this PropertyDescriptor against the specified object.
    Class<?>
    getIndexedPropertyType()
    Returns the Java type info for the indexed property.
    Method
    getIndexedReadMethod()
    Gets the method that should be used to read an indexed property value.
    Method
    getIndexedWriteMethod()
    Gets the method that should be used to write an indexed property value.
    int
    hashCode()
    Returns a hash code value for the object.
    void
    setIndexedReadMethod(Method readMethod)
    Sets the method that should be used to read an indexed property value.
    void
    setIndexedWriteMethod(Method writeMethod)
    Sets the method that should be used to write an indexed property value.

    Methods declared in class PropertyDescriptor

    createPropertyEditor, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod
    Modifier and Type
    Method
    Description
    PropertyEditor
    createPropertyEditor(Object bean)
    Constructs an instance of a property editor using the current property editor class.
    Class<?>
    getPropertyEditorClass()
    Gets any explicit PropertyEditor Class that has been registered for this property.
    Class<?>
    getPropertyType()
    Returns the Java type info for the property.
    Method
    getReadMethod()
    Gets the method that should be used to read the property value.
    Method
    getWriteMethod()
    Gets the method that should be used to write the property value.
    boolean
    isBound()
    Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.
    boolean
    isConstrained()
    Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.
    void
    setBound(boolean bound)
    Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.
    void
    setConstrained(boolean constrained)
    Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.
    void
    setPropertyEditorClass(Class<?> propertyEditorClass)
    Normally PropertyEditors will be found using the PropertyEditorManager.
    void
    setReadMethod(Method readMethod)
    Sets the method that should be used to read the property value.
    void
    setWriteMethod(Method writeMethod)
    Sets the method that should be used to write the property value.

    Methods declared in class FeatureDescriptor

    attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString
    Modifier and Type
    Method
    Description
    Enumeration<String>
    attributeNames()
    Gets an enumeration of the locale-independent names of this feature.
    String
    getDisplayName()
    Gets the localized display name of this feature.
    String
    getName()
    Gets the programmatic name of this feature.
    String
    getShortDescription()
    Gets the short description of this feature.
    Object
    getValue(String attributeName)
    Retrieve a named attribute with this feature.
    boolean
    isExpert()
    The "expert" flag is used to distinguish between those features that are intended for expert users from those that are intended for normal users.
    boolean
    isHidden()
    The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.
    boolean
    isPreferred()
    The "preferred" flag is used to identify features that are particularly important for presenting to humans.
    void
    setDisplayName(String displayName)
    Sets the localized display name of this feature.
    void
    setExpert(boolean expert)
    The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.
    void
    setHidden(boolean hidden)
    The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.
    void
    setName(String name)
    Sets the programmatic name of this feature.
    void
    setPreferred(boolean preferred)
    The "preferred" flag is used to identify features that are particularly important for presenting to humans.
    void
    setShortDescription(String text)
    You can associate a short descriptive string with a feature.
    void
    setValue(String attributeName, Object value)
    Associate a named attribute with this feature.
    String
    toString()
    Returns a string representation of the object.

    Methods declared in class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Creates and returns a copy of this object.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • Constructor Details

    • IndexedPropertyDescriptor

      public IndexedPropertyDescriptor(String propertyName, Class<?> beanClass) throws IntrospectionException
      This constructor constructs an IndexedPropertyDescriptor for a property that follows the standard Java conventions by having getFoo and setFoo accessor methods, for both indexed access and array access.

      Thus if the argument name is "fred", it will assume that there is an indexed reader method "getFred", a non-indexed (array) reader method also called "getFred", an indexed writer method "setFred", and finally a non-indexed writer method "setFred".

      Parameters:
      propertyName - The programmatic name of the property.
      beanClass - The Class object for the target bean.
      Throws:
      IntrospectionException - if an exception occurs during introspection.

    • IndexedPropertyDescriptor

      public IndexedPropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName, String indexedReadMethodName, String indexedWriteMethodName) throws IntrospectionException
      This constructor takes the name of a simple property, and method names for reading and writing the property, both indexed and non-indexed.
      Parameters:
      propertyName - The programmatic name of the property.
      beanClass - The Class object for the target bean.
      readMethodName - The name of the method used for reading the property values as an array. May be null if the property is write-only or must be indexed.
      writeMethodName - The name of the method used for writing the property values as an array. May be null if the property is read-only or must be indexed.
      indexedReadMethodName - The name of the method used for reading an indexed property value. May be null if the property is write-only.
      indexedWriteMethodName - The name of the method used for writing an indexed property value. May be null if the property is read-only.
      Throws:
      IntrospectionException - if an exception occurs during introspection.

    • IndexedPropertyDescriptor

      public IndexedPropertyDescriptor(String propertyName, Method readMethod, Method writeMethod, Method indexedReadMethod, Method indexedWriteMethod) throws IntrospectionException
      This constructor takes the name of a simple property, and Method objects for reading and writing the property.
      Parameters:
      propertyName - The programmatic name of the property.
      readMethod - The method used for reading the property values as an array. May be null if the property is write-only or must be indexed.
      writeMethod - The method used for writing the property values as an array. May be null if the property is read-only or must be indexed.
      indexedReadMethod - The method used for reading an indexed property value. May be null if the property is write-only.
      indexedWriteMethod - The method used for writing an indexed property value. May be null if the property is read-only.
      Throws:
      IntrospectionException - if an exception occurs during introspection.

  • Method Details

    • getIndexedReadMethod

      public Method getIndexedReadMethod()
      Gets the method that should be used to read an indexed property value.
      Returns:
      The method that should be used to read an indexed property value. May return null if the property isn't indexed or is write-only.

    • setIndexedReadMethod

      public void setIndexedReadMethod(Method readMethod) throws IntrospectionException
      Sets the method that should be used to read an indexed property value.
      Parameters:
      readMethod - The new indexed read method.
      Throws:
      IntrospectionException - if an exception occurs during introspection.
      Since:
      1.2

    • getIndexedWriteMethod

      public Method getIndexedWriteMethod()
      Gets the method that should be used to write an indexed property value.
      Returns:
      The method that should be used to write an indexed property value. May return null if the property isn't indexed or is read-only.

    • setIndexedWriteMethod

      public void setIndexedWriteMethod(Method writeMethod) throws IntrospectionException
      Sets the method that should be used to write an indexed property value.
      Parameters:
      writeMethod - The new indexed write method.
      Throws:
      IntrospectionException - if an exception occurs during introspection.
      Since:
      1.2

    • getIndexedPropertyType

      public Class<?> getIndexedPropertyType()
      Returns the Java type info for the indexed property. Note that the Class object may describe primitive Java types such as int. This type is returned by the indexed read method or is used as the parameter type of the indexed write method.
      Returns:
      the Class object that represents the Java type info, or null if the type cannot be determined

    • equals

      public boolean equals(Object obj)
      Compares this PropertyDescriptor against the specified object. Returns true if the objects are the same. Two PropertyDescriptors are the same if the read, write, property types, property editor and flags are equivalent.
      Overrides:
      equals in class PropertyDescriptor
      Parameters:
      obj - the reference object with which to compare.
      Returns:
      true if this object is the same as the obj argument; false otherwise.
      Since:
      1.4
      See Also:

    • hashCode

      public int hashCode()
      Returns a hash code value for the object. See Object.hashCode() for a complete description.
      Overrides:
      hashCode in class PropertyDescriptor
      Returns:
      a hash code value for this object.
      Since:
      1.5
      See Also: