Java™ Platform
Standard Ed. 6

java.beans
Class IndexedPropertyDescriptor

java.lang.Object
  extended by java.beans.FeatureDescriptor
      extended by java.beans.PropertyDescriptor
          extended by 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.


Constructor Summary
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
 boolean equals(Object obj)
          Compares this PropertyDescriptor against the specified object.
 Class<?> getIndexedPropertyType()
          Gets the Class object of the indexed properties' type.
 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 inherited from class java.beans.PropertyDescriptor
createPropertyEditor, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, 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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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

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

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

getIndexedPropertyType

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

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:
Object.hashCode(), Hashtable

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:
Object.equals(java.lang.Object), Hashtable

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.