OpenJDK 27 · java.beans.PropertyDescriptor · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private String	baseName
private boolean	bound
private boolean	constrained
private Reference<? extends Class<?>>	propertyEditorClassRef
private Reference<? extends Class<?>>	propertyTypeRef
private String	readMethodName
private final MethodRef	readMethodRef
private String	writeMethodName
private final MethodRef	writeMethodRef

Constructor Summary

Access	Constructor and Description
public	PropertyDescriptor(String The programmatic name of the property. propertyName, Class<?> The Class object for the target bean. For example sun.beans.OurButton.class. beanClass) Constructs a PropertyDescriptor for a property that follows the standard Java convention by having getFoo and setFoo accessor methods.
public	PropertyDescriptor(String The programmatic name of the property. propertyName, Class<?> The Class object for the target bean. For example sun.beans.OurButton.class. beanClass, String The name of the method used for reading the property value. May be null if the property is write-only. readMethodName, String The name of the method used for writing the property value. May be null if the property is read-only. writeMethodName) This constructor takes the name of a simple property, and method names for reading and writing the property.
public	PropertyDescriptor(String The programmatic name of the property. propertyName, Method The method used for reading the property value. May be null if the property is write-only. readMethod, Method The method used for writing the property value. May be null if the property is read-only. writeMethod) This constructor takes the name of a simple property, and Method objects for reading and writing the property.
pack-priv	PropertyDescriptor(Map.Entry<String, PropertyInfo> the pair of values, where the `key` is the base name of the property (the rest of the method name) and the `value` is the automatically generated property info entry, boolean the flag indicating whether it is possible to treat this property as a bound property bound) Creates `PropertyDescriptor` from the specified property info.
pack-priv	PropertyDescriptor(PropertyDescriptor The first (lower priority) PropertyDescriptor x, PropertyDescriptor The second (higher priority) PropertyDescriptor y) Package-private constructor.
pack-priv	PropertyDescriptor(PropertyDescriptor old)

Method Summary

Modifier and Type	Method and Description
pack-priv void	appendTo(StringBuilder sb) Overrides java.beans.FeatureDescriptor.appendTo.
pack-priv boolean	Returns: boolean to indicate that the methods are equivalent compareMethods(Method first method to compare a, Method second method to compare b) Package private helper method for Descriptor .equals methods.
public PropertyEditor	Returns: a property editor instance or null if a property editor has not been defined or cannot be created createPropertyEditor(Object the source object bean) Constructs an instance of a property editor using the current property editor class.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Compares this `PropertyDescriptor` against the specified object.
private Class<?>	Returns: the type of the property descriptor or null if both read and write methods are null. findPropertyType(Method readMethod, Method writeMethod) Returns the property type that corresponds to the read and write method.
pack-priv String	getBaseName()
public Class<?>	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. getPropertyEditorClass() Gets any explicit PropertyEditor Class that has been registered for this property.
public synchronized Class<?>	Returns: the `Class` object that represents the Java type info, or `null` if the type cannot be determined getPropertyType() Returns the Java type info for the property.
private Class<?>	getPropertyType0()
public synchronized Method	Returns: The method that should be used to read the property value. May return null if the property can't be read. getReadMethod() Gets the method that should be used to read the property value.
public synchronized Method	Returns: The method that should be used to write the property value. May return null if the property can't be written. getWriteMethod() Gets the method that should be used to write the property value.
public int	Returns: a hash code value for this object. hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv boolean	isAssignable(Method m1, Method m2)
public boolean	Returns: True if this is a bound property. isBound() Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.
public boolean	Returns: True if this is a constrained property. isConstrained() Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.
public void	setBound(boolean True if this is a bound property. bound) Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.
pack-priv void	setClass0(Class<?> clz) Overrides java.beans.FeatureDescriptor.setClass0. Overridden to ensure that a super class doesn't take precedent
public void	setConstrained(boolean True if this is a constrained property. constrained) Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.
public void	setPropertyEditorClass(Class<?> The Class for the desired PropertyEditor. propertyEditorClass) Normally PropertyEditors will be found using the PropertyEditorManager.
private void	setPropertyType(Class<?> type)
public synchronized void	setReadMethod(Method The new read method. readMethod) Sets the method that should be used to read the property value.
private void	setReadMethod0(Method readMethod)
public synchronized void	setWriteMethod(Method The new write method. writeMethod) Sets the method that should be used to write the property value.
private void	setWriteMethod0(Method writeMethod)
pack-priv void	updateGenericsFor(Class<?> type)

Field Detail

baseName	back to summary
private String baseName

bound	back to summary
private boolean bound

constrained	back to summary
private boolean constrained

propertyEditorClassRef	back to summary
private Reference<? extends Class<?>> propertyEditorClassRef

propertyTypeRef	back to summary
private Reference<? extends Class<?>> propertyTypeRef

readMethodName	back to summary
private String readMethodName

readMethodRef	back to summary
private final MethodRef readMethodRef

writeMethodName	back to summary
private String writeMethodName

writeMethodRef	back to summary
private final MethodRef writeMethodRef

Constructor Detail

PropertyDescriptor	back to summary
public PropertyDescriptor(String propertyName, Class<?> beanClass) throws IntrospectionException Constructs a PropertyDescriptor for a property that follows the standard Java convention by having getFoo and setFoo accessor methods. Thus if the argument name is "fred", it will assume that the writer method is "setFred" and the reader method is "getFred" (or "isFred" for a boolean property). Note that the property name should start with a lower case character, which will be capitalized in the method names. Parameters propertyName:String The programmatic name of the property. beanClass:Class<?> The Class object for the target bean. For example sun.beans.OurButton.class. Exceptions IntrospectionException: if an exception occurs during introspection.

PropertyDescriptor

back to summary

public PropertyDescriptor(String propertyName, Class<?> beanClass) throws IntrospectionException

Constructs a PropertyDescriptor for a property that follows the standard Java convention by having getFoo and setFoo accessor methods. Thus if the argument name is "fred", it will assume that the writer method is "setFred" and the reader method is "getFred" (or "isFred" for a boolean property). Note that the property name should start with a lower case character, which will be capitalized in the method names.

Parameters

propertyName:String: The programmatic name of the property.
beanClass:Class<?>: The Class object for the target bean. For example sun.beans.OurButton.class.

Exceptions

IntrospectionException:: if an exception occurs during introspection.

PropertyDescriptor	back to summary
public PropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName) throws IntrospectionException This constructor takes the name of a simple property, and method names for reading and writing the property. Parameters propertyName:String The programmatic name of the property. beanClass:Class<?> The Class object for the target bean. For example sun.beans.OurButton.class. readMethodName:String The name of the method used for reading the property value. May be null if the property is write-only. writeMethodName:String The name of the method used for writing the property value. May be null if the property is read-only. Exceptions IntrospectionException: if an exception occurs during introspection.

PropertyDescriptor

back to summary

public PropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName) throws IntrospectionException

This constructor takes the name of a simple property, and method names for reading and writing the property.

Parameters

propertyName:String: The programmatic name of the property.
beanClass:Class<?>: The Class object for the target bean. For example sun.beans.OurButton.class.
readMethodName:String: The name of the method used for reading the property value. May be null if the property is write-only.
writeMethodName:String: The name of the method used for writing the property value. May be null if the property is read-only.

Exceptions

IntrospectionException:: if an exception occurs during introspection.

PropertyDescriptor	back to summary
public PropertyDescriptor(String propertyName, Method readMethod, Method writeMethod) throws IntrospectionException This constructor takes the name of a simple property, and Method objects for reading and writing the property. Parameters propertyName:String The programmatic name of the property. readMethod:Method The method used for reading the property value. May be null if the property is write-only. writeMethod:Method The method used for writing the property value. May be null if the property is read-only. Exceptions IntrospectionException: if an exception occurs during introspection.

PropertyDescriptor

back to summary

public PropertyDescriptor(String propertyName, Method readMethod, Method writeMethod) throws IntrospectionException

This constructor takes the name of a simple property, and Method objects for reading and writing the property.

Parameters

propertyName:String: The programmatic name of the property.
readMethod:Method: The method used for reading the property value. May be null if the property is write-only.
writeMethod:Method: The method used for writing the property value. May be null if the property is read-only.

Exceptions

IntrospectionException:: if an exception occurs during introspection.

PropertyDescriptor back to summary

PropertyDescriptor	back to summary
pack-priv PropertyDescriptor(Map.Entry<String, PropertyInfo> entry, boolean bound) Creates `PropertyDescriptor` from the specified property info. Parameters entry:Map.Entry<String, PropertyInfo> the pair of values, where the `key` is the base name of the property (the rest of the method name) and the `value` is the automatically generated property info bound:boolean the flag indicating whether it is possible to treat this property as a bound property Since 9

pack-priv PropertyDescriptor(Map.Entry<String, PropertyInfo> entry, boolean bound)

Creates PropertyDescriptor from the specified property info.

Parameters

entry:Map.Entry<String, PropertyInfo>: the pair of values, where the key is the base name of the property (the rest of the method name) and the value is the automatically generated property info
bound:boolean: the flag indicating whether it is possible to treat this property as a bound property

Since

PropertyDescriptor	back to summary
pack-priv PropertyDescriptor(PropertyDescriptor x, PropertyDescriptor y) Package-private constructor. Merge two property descriptors. Where they conflict, give the second argument (y) priority over the first argument (x). Parameters x:PropertyDescriptor The first (lower priority) PropertyDescriptor y:PropertyDescriptor The second (higher priority) PropertyDescriptor

PropertyDescriptor

back to summary

pack-priv PropertyDescriptor(PropertyDescriptor x, PropertyDescriptor y)

Package-private constructor. Merge two property descriptors. Where they conflict, give the second argument (y) priority over the first argument (x).

Parameters

x:PropertyDescriptor: The first (lower priority) PropertyDescriptor
y:PropertyDescriptor: The second (higher priority) PropertyDescriptor

PropertyDescriptor	back to summary
pack-priv PropertyDescriptor(PropertyDescriptor old)

Method Detail

appendTo	back to summary
pack-priv void appendTo(StringBuilder sb) Overrides java.beans.FeatureDescriptor.appendTo. Annotations @Override

appendTo

back to summary

pack-priv void appendTo(StringBuilder sb)

Overrides java.beans.FeatureDescriptor.appendTo.

Annotations

@Override

compareMethods	back to summary
pack-priv boolean compareMethods(Method a, Method b) Package private helper method for Descriptor .equals methods. Parameters a:Method first method to compare b:Method second method to compare Returns:boolean boolean to indicate that the methods are equivalent

compareMethods

back to summary

pack-priv boolean compareMethods(Method a, Method b)

Package private helper method for Descriptor .equals methods.

Parameters

a:Method: first method to compare
b:Method: second method to compare

Returns:boolean

boolean to indicate that the methods are equivalent

createPropertyEditor	back to summary
public PropertyEditor createPropertyEditor(Object bean) Constructs an instance of a property editor using the current property editor class. 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:Object the source object Returns:PropertyEditor a property editor instance or null if a property editor has not been defined or cannot be created Annotations @SuppressWarnings:deprecation Since 1.5

createPropertyEditor

back to summary

public PropertyEditor createPropertyEditor(Object bean)

Constructs an instance of a property editor using the current property editor class.

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:Object: the source object

Returns:PropertyEditor

a property editor instance or null if a property editor has not been defined or cannot be created

Annotations

@SuppressWarnings:deprecation

Since

1.5

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Compares this `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. Annotations @Override Since 1.4

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

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.

Annotations

@Override

Since

1.4

findPropertyType	back to summary
private Class<?> findPropertyType(Method readMethod, Method writeMethod) throws IntrospectionException Returns the property type that corresponds to the read and write method. The type precedence is given to the readMethod. Returns:Class<?> the type of the property descriptor or null if both read and write methods are null. Exceptions IntrospectionException: if the read or write method is invalid

findPropertyType

back to summary

private Class<?> findPropertyType(Method readMethod, Method writeMethod) throws IntrospectionException

Returns the property type that corresponds to the read and write method. The type precedence is given to the readMethod.

Returns:Class<?>

the type of the property descriptor or null if both read and write methods are null.

Exceptions

IntrospectionException:: if the read or write method is invalid

getBaseName	back to summary
pack-priv String getBaseName()

getPropertyEditorClass	back to summary
public Class<?> getPropertyEditorClass() Gets any explicit PropertyEditor Class that has been registered for this property. Returns:Class<?> 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.

getPropertyEditorClass

back to summary

public Class<?> getPropertyEditorClass()

Gets any explicit PropertyEditor Class that has been registered for this property.

Returns:Class<?>: 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.

getPropertyType back to summary

getPropertyType	back to summary
public synchronized Class<?> getPropertyType() Returns the Java type info for the property. Note that the `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:Class<?> the `Class` object that represents the Java type info, or `null` if the type cannot be determined

public synchronized Class<?> getPropertyType()

Returns the Java type info for the property. Note that the 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:Class<?>: the Class object that represents the Java type info, or null if the type cannot be determined

getPropertyType0	back to summary
private Class<?> getPropertyType0()

getReadMethod	back to summary
public synchronized Method getReadMethod() Gets the method that should be used to read the property value. Returns:Method The method that should be used to read the property value. May return null if the property can't be read.

getReadMethod

back to summary

public synchronized Method getReadMethod()

Gets the method that should be used to read the property value.

Returns:Method: The method that should be used to read the property value. May return null if the property can't be read.

getWriteMethod	back to summary
public synchronized Method getWriteMethod() Gets the method that should be used to write the property value. Returns:Method The method that should be used to write the property value. May return null if the property can't be written.

getWriteMethod

back to summary

public synchronized Method getWriteMethod()

Gets the method that should be used to write the property value.

Returns:Method: The method that should be used to write the property value. May return null if the property can't be written.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object. See `java.lang.Object#hashCode` for a complete description. Returns:int a hash code value for this object. Annotations @Override Since 1.5

public int hashCode()

Overrides java.lang.Object.hashCode.

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

Returns:int

a hash code value for this object.

Annotations

@Override

Since

1.5

isAssignable	back to summary
pack-priv boolean isAssignable(Method m1, Method m2)

isBound	back to summary
public boolean isBound() Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed. Returns:boolean True if this is a bound property.

isBound

back to summary

public boolean isBound()

Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.

Returns:boolean: True if this is a bound property.

isConstrained	back to summary
public boolean isConstrained() Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed. Returns:boolean True if this is a constrained property.

isConstrained

back to summary

public boolean isConstrained()

Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.

Returns:boolean: True if this is a constrained property.

setBound	back to summary
public void setBound(boolean bound) Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed. Parameters bound:boolean True if this is a bound property.

setBound

back to summary

public void setBound(boolean bound)

Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.

Parameters

bound:boolean: True if this is a bound property.

setClass0	back to summary
pack-priv void setClass0(Class<?> clz) Overrides java.beans.FeatureDescriptor.setClass0. Overridden to ensure that a super class doesn't take precedent Annotations @Override

setClass0

back to summary

pack-priv void setClass0(Class<?> clz)

Overrides java.beans.FeatureDescriptor.setClass0.

Overridden to ensure that a super class doesn't take precedent

Annotations

@Override

setConstrained	back to summary
public void setConstrained(boolean constrained) Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed. Parameters constrained:boolean True if this is a constrained property.

setConstrained

back to summary

public void setConstrained(boolean constrained)

Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.

Parameters

constrained:boolean: True if this is a constrained property.

setPropertyEditorClass	back to summary
public void setPropertyEditorClass(Class<?> propertyEditorClass) Normally PropertyEditors will be found using the PropertyEditorManager. However if for some reason you want to associate a particular PropertyEditor with a given property, then you can do it with this method. Parameters propertyEditorClass:Class<?> The Class for the desired PropertyEditor.

setPropertyEditorClass

back to summary

public void setPropertyEditorClass(Class<?> propertyEditorClass)

Normally PropertyEditors will be found using the PropertyEditorManager. However if for some reason you want to associate a particular PropertyEditor with a given property, then you can do it with this method.

Parameters

propertyEditorClass:Class<?>: The Class for the desired PropertyEditor.

setPropertyType	back to summary
private void setPropertyType(Class<?> type)

setReadMethod	back to summary
public synchronized void setReadMethod(Method readMethod) throws IntrospectionException Sets the method that should be used to read the property value. Parameters readMethod:Method The new read method. Exceptions IntrospectionException: if the read method is invalid Since 1.2

setReadMethod

back to summary

public synchronized void setReadMethod(Method readMethod) throws IntrospectionException

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

Parameters

readMethod:Method: The new read method.

Exceptions

IntrospectionException:: if the read method is invalid

Since

1.2

setReadMethod0	back to summary
private void setReadMethod0(Method readMethod)

setWriteMethod	back to summary
public synchronized void setWriteMethod(Method writeMethod) throws IntrospectionException Sets the method that should be used to write the property value. Parameters writeMethod:Method The new write method. Exceptions IntrospectionException: if the write method is invalid Since 1.2

setWriteMethod

back to summary

public synchronized void setWriteMethod(Method writeMethod) throws IntrospectionException

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

Parameters

writeMethod:Method: The new write method.

Exceptions

IntrospectionException:: if the write method is invalid

Since

1.2

setWriteMethod0	back to summary
private void setWriteMethod0(Method writeMethod)

updateGenericsFor	back to summary
pack-priv void updateGenericsFor(Class<?> type)

public Class PropertyDescriptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail