public class

IndexedPropertyDescriptor

extends PropertyDescriptor
java.lang.Object
   ↳ java.beans.FeatureDescriptor
     ↳ java.beans.PropertyDescriptor
       ↳ java.beans.IndexedPropertyDescriptor

Class Overview

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.

Summary

Public Constructors
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.
Public Methods
boolean equals(Object obj)
Compares this PropertyDescriptor against the specified object.
synchronized Class<?> getIndexedPropertyType()
Gets the Class object of the indexed properties' type.
synchronized Method getIndexedReadMethod()
Gets the method that should be used to read an indexed property value.
synchronized 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.
synchronized void setIndexedReadMethod(Method readMethod)
Sets the method that should be used to read an indexed property value.
synchronized void setIndexedWriteMethod(Method writeMethod)
Sets the method that should be used to write an indexed property value.
[Expand]
Inherited Methods
From class java.beans.PropertyDescriptor
From class java.beans.FeatureDescriptor
From class java.lang.Object

Public Constructors

public 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.

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.

public 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.

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.

public 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.

Parameters
propertyName The programmatic name of the pro perty.
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.

Public Methods

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.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public synchronized Class<?> getIndexedPropertyType ()

Gets the Class object of the indexed properties' type. The returned Class may describe a primitive type such as int.

Returns
  • The Class for the indexed properties' type; may return null if the type cannot be determined.

public synchronized 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.

public synchronized 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.

public int hashCode ()

Returns a hash code value for the object. See hashCode() for a complete description.

Returns
  • a hash code value for this object.

public synchronized void setIndexedReadMethod (Method readMethod)

Sets the method that should be used to read an indexed property value.

Parameters
readMethod The new indexed read method.
Throws
IntrospectionException

public synchronized void setIndexedWriteMethod (Method writeMethod)

Sets the method that should be used to write an indexed property value.

Parameters
writeMethod The new indexed write method.
Throws
IntrospectionException