APIdia Launch Partner
Top Description Methods
java.beans

public @Interface BeanProperty

extends Annotation
Annotations
@Documented
@Target:METHOD
@Retention:RUNTIME
Imports
java.lang.annotation.Documented, .Retention, .Target
An annotation used to specify some property-related information for the automatically generated BeanInfo classes. This annotation is not used if the annotated class has a corresponding user-defined BeanInfo class, which does not imply the automatic analysis. If both the read and the write methods of the property are annotated, then the read method annotation will have more priority and replace the write method annotation.
Author
Sergey A. Malenkov
Since
9
See Also
BeanInfo#getPropertyDescriptors

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the annotated property can be a bound property; false otherwise.
bound()

The value that indicates whether the annotated property can be a bound property or not.

public String

Returns:

the property description, or an empty string if the description is not set.
description()

The short description for the descriptor of the annotated property.

public String[]

Returns:

the names of the valid values of the annotated property, or an empty array if the names are not provided.
enumerationValues()

The array of names for the public static fields that contains the valid values of the annotated property.

public boolean

Returns:

true if the annotated property is an expert property; false otherwise.
expert()

The value that indicates whether the annotated property is an expert property or not.

public boolean

Returns:

true if the annotated property is a hidden property; false otherwise.
hidden()

The value that indicates whether the annotated property is a hidden property or not.

public boolean

Returns:

true if the annotated property is a preferred property; false otherwise.
preferred()

The value that indicates whether the annotated property is a preferred property or not.

public boolean

Returns:

true if the annotated property is a required property; false otherwise.
required()

The value that indicates whether the annotated property is a required property or not.

public boolean

Returns:

true if the corresponding component is repainted; false otherwise.
visualUpdate()

The value that indicates whether the corresponding component is repainted after the annotated property got changed or not.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

boundback to summary
public boolean bound()

The value that indicates whether the annotated property can be a bound property or not. This value applies only to the beans that have the propertyChange event set.

Returns:boolean

true if the annotated property can be a bound property; false otherwise.

descriptionback to summary
public String description()

The short description for the descriptor of the annotated property.

Returns:String

the property description, or an empty string if the description is not set.

enumerationValuesback to summary
public String[] enumerationValues()

The array of names for the public static fields that contains the valid values of the annotated property. These names are used to generate the enumerationValues feature attribute that must contain the following items per each property value: a displayable name for the property value, the actual property value, and a Java code piece used for the code generator.

Returns:String[]

the names of the valid values of the annotated property, or an empty array if the names are not provided.

expertback to summary
public boolean expert()

The value that indicates whether the annotated property is an expert property or not.

Returns:boolean

true if the annotated property is an expert property; false otherwise.

hiddenback to summary
public boolean hidden()

The value that indicates whether the annotated property is a hidden property or not.

Returns:boolean

true if the annotated property is a hidden property; false otherwise.

preferredback to summary
public boolean preferred()

The value that indicates whether the annotated property is a preferred property or not.

Returns:boolean

true if the annotated property is a preferred property; false otherwise.

requiredback to summary
public boolean required()

The value that indicates whether the annotated property is a required property or not.

Returns:boolean

true if the annotated property is a required property; false otherwise.

visualUpdateback to summary
public boolean visualUpdate()

The value that indicates whether the corresponding component is repainted after the annotated property got changed or not.

Returns:boolean

true if the corresponding component is repainted; false otherwise.