Class PropertyDescriptor

java.lang.Object
java.beans.FeatureDescriptor
java.beans.PropertyDescriptor
Direct Known Subclasses:
IndexedPropertyDescriptor
public class PropertyDescriptor extends FeatureDescriptor
A PropertyDescriptor describes one property that a Java Bean exports via a pair of accessor methods.
Since:
1.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    PropertyDescriptor(String propertyName, Class<?> beanClass)
    Constructs a PropertyDescriptor for a property that follows the standard Java convention by having getFoo and setFoo accessor methods.
    PropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName)
    This constructor takes the name of a simple property, and method names for reading and writing the property.
    PropertyDescriptor(String propertyName, Method readMethod, Method writeMethod)
    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(Object bean)
    Constructs an instance of a property editor using the current property editor class.
    boolean
    equals(Object obj)
    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(boolean bound)
    Updates to "bound" properties will cause a "PropertyChange" event to get fired when the property is changed.
    void
    setConstrained(boolean constrained)
    Attempted updates to "Constrained" properties will cause a "VetoableChange" event to get fired when the property is changed.
    void
    setPropertyEditorClass(Class<?> propertyEditorClass)
    Normally PropertyEditors will be found using the PropertyEditorManager.
    void
    setReadMethod(Method readMethod)
    Sets the method that should be used to read the property value.
    void
    setWriteMethod(Method writeMethod)
    Sets the method that should be used to write the property value.

    Methods declared in class FeatureDescriptor

    attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString
    Modifier and Type
    Method
    Description
    Enumeration<String>
    attributeNames()
    Gets an enumeration of the locale-independent names of this feature.
    String
    getDisplayName()
    Gets the localized display name of this feature.
    String
    getName()
    Gets the programmatic name of this feature.
    String
    getShortDescription()
    Gets the short description of this feature.
    Object
    getValue(String attributeName)
    Retrieve a named attribute with this feature.
    boolean
    isExpert()
    The "expert" flag is used to distinguish between those features that are intended for expert users from those that are intended for normal users.
    boolean
    isHidden()
    The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.
    boolean
    isPreferred()
    The "preferred" flag is used to identify features that are particularly important for presenting to humans.
    void
    setDisplayName(String displayName)
    Sets the localized display name of this feature.
    void
    setExpert(boolean expert)
    The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.
    void
    setHidden(boolean hidden)
    The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.
    void
    setName(String name)
    Sets the programmatic name of this feature.
    void
    setPreferred(boolean preferred)
    The "preferred" flag is used to identify features that are particularly important for presenting to humans.
    void
    setShortDescription(String text)
    You can associate a short descriptive string with a feature.
    void
    setValue(String attributeName, Object value)
    Associate a named attribute with this feature.
    String
    toString()
    Returns a string representation of the object.

    Methods declared in class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • PropertyDescriptor

      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 - 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
      This constructor takes the name of a simple property, and method names for reading and writing the property.
      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
      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 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()
      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:
      the Class object that represents the Java type info, or null if the type cannot be determined

    • getReadMethod

      public Method getReadMethod()
      Gets the method that should be used to read the property value.
      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
      Sets the method that should be used to read the property value.
      Parameters:
      readMethod - The new read method.
      Throws:
      IntrospectionException - if the read method is invalid
      Since:
      1.2

    • getWriteMethod

      public Method getWriteMethod()
      Gets the method that should be used to write the property value.
      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
      Sets the method that should be used to write the property value.
      Parameters:
      writeMethod - The new write method.
      Throws:
      IntrospectionException - if the write method is invalid
      Since:
      1.2

    • isBound

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

    • setBound

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

    • isConstrained

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

    • setConstrained

      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 - True if this is a constrained property.

    • setPropertyEditorClass

      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 - The Class for the desired PropertyEditor.

    • getPropertyEditorClass

      public Class<?> getPropertyEditorClass()
      Gets any explicit PropertyEditor Class that has been registered for this property.
      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)
      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 - 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)
      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 Object
      Parameters:
      obj - Object the object to compare with this object.
      Returns:
      boolean true if the object is the same as this object false if it is different from this object.
      Since:
      1.4
      See Also:

    • hashCode

      public int hashCode()
      Returns a hash code value for the object. See Object.hashCode() for a complete description.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this object.
      Since:
      1.5
      See Also: