On this page
Class PropertyDescriptor
- Direct Known Subclasses:
-
IndexedPropertyDescriptor
public class PropertyDescriptor extends FeatureDescriptor
- Since:
- 1.1
Constructor Summary
Constructor | Description |
---|---|
PropertyDescriptor |
Constructs a PropertyDescriptor for a property that follows the standard Java convention by having getFoo and setFoo accessor methods.
|
PropertyDescriptor |
This constructor takes the name of a simple property, and method names for reading and writing the property.
|
PropertyDescriptor |
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 |
---|---|---|
PropertyEditor |
createPropertyEditor |
Constructs an instance of a property editor using the current property editor class.
|
boolean |
equals |
Compares this PropertyDescriptor against the specified object.
|
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.
|
int |
hashCode() |
Returns a hash code value for the object.
|
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 |
Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.
|
void |
setConstrained |
Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.
|
void |
setPropertyEditorClass |
Normally PropertyEditors will be found using the PropertyEditorManager.
|
void |
setReadMethod |
Sets the method that should be used to read the property value.
|
void |
setWriteMethod |
Sets the method that should be used to write the property value.
|
Methods declared in class java.beans.FeatureDescriptor
attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString
Constructor Details
PropertyDescriptor
public PropertyDescriptor(String propertyName, Class<?> beanClass) throws IntrospectionException
- Parameters:
propertyName
- The programmatic name of the property.beanClass
- The Class object for the target bean. For example sun.beans.OurButton.class.- Throws:
IntrospectionException
- if an exception occurs during introspection.
PropertyDescriptor
public PropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName) throws IntrospectionException
- Parameters:
propertyName
- The programmatic name of the property.beanClass
- The Class object for the target bean. For example sun.beans.OurButton.class.readMethodName
- The name of the method used for reading the property value. May be null if the property is write-only.writeMethodName
- The name of the method used for writing the property value. May be null if the property is read-only.- Throws:
IntrospectionException
- if an exception occurs during introspection.
PropertyDescriptor
public PropertyDescriptor(String propertyName, Method readMethod, Method writeMethod) throws IntrospectionException
- Parameters:
propertyName
- The programmatic name of the property.readMethod
- The method used for reading the property value. May be null if the property is write-only.writeMethod
- The method used for writing the property value. May be null if the property is read-only.- Throws:
IntrospectionException
- if an exception occurs during introspection.
Method Details
getPropertyType
public Class<?> getPropertyType()
Class
object may describe primitive Java types such as int
. This type is returned by the read method or is used as the parameter type of the write method. Returns null
if the type is an indexed property that does not support non-indexed access.
- Returns:
-
the
Class
object that represents the Java type info, ornull
if the type cannot be determined
getReadMethod
public Method getReadMethod()
- Returns:
- The method that should be used to read the property value. May return null if the property can't be read.
setReadMethod
public void setReadMethod(Method readMethod) throws IntrospectionException
- Parameters:
readMethod
- The new read method.- Throws:
IntrospectionException
- if the read method is invalid- Since:
- 1.2
getWriteMethod
public Method getWriteMethod()
- Returns:
- The method that should be used to write the property value. May return null if the property can't be written.
setWriteMethod
public void setWriteMethod(Method writeMethod) throws IntrospectionException
- Parameters:
writeMethod
- The new write method.- Throws:
IntrospectionException
- if the write method is invalid- Since:
- 1.2
isBound
public boolean isBound()
- Returns:
- True if this is a bound property.
setBound
public void setBound(boolean bound)
- Parameters:
bound
- True if this is a bound property.
isConstrained
public boolean isConstrained()
- Returns:
- True if this is a constrained property.
setConstrained
public void setConstrained(boolean constrained)
- Parameters:
constrained
- True if this is a constrained property.
setPropertyEditorClass
public void setPropertyEditorClass(Class<?> propertyEditorClass)
- Parameters:
propertyEditorClass
- The Class for the desired PropertyEditor.
getPropertyEditorClass
public Class<?> getPropertyEditorClass()
- Returns:
- Any explicit PropertyEditor Class that has been registered for this property. Normally this will return "null", indicating that no special editor has been registered, so the PropertyEditorManager should be used to locate a suitable PropertyEditor.
createPropertyEditor
public PropertyEditor createPropertyEditor(Object bean)
If the property editor class has a public constructor that takes an Object argument then it will be invoked using the bean parameter as the argument. Otherwise, the default constructor will be invoked.
- Parameters:
bean
- the source object- Returns:
- a property editor instance or null if a property editor has not been defined or cannot be created
- Since:
- 1.5
equals
public boolean equals(Object obj)
PropertyDescriptor
against the specified object. Returns true if the objects are the same. Two PropertyDescriptor
s are the same if the read, write, property types, property editor and flags are equivalent.
hashCode
public int hashCode()
Object.hashCode()
for a complete description.
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/beans/PropertyDescriptor.html