java.beans
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.

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

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

getIndexedPropertyType

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.

getIndexedReadMethod

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.

getIndexedWriteMethod

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.

hashCode

public int hashCode()

Returns a hash code value for the object. See {@link java.lang.Object#hashCode} for a complete description.

Overrides:

hashCode in class PropertyDescriptor

Returns:

a hash code value for this object.

setIndexedReadMethod

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

setIndexedWriteMethod

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