src/share/classes/java/beans/BeanInfo.java

Print this page
rev 10053 : 8044855: Add missing @since tag under java.beans.*
Reviewed-by:


  31  * Use the {@code BeanInfo} interface
  32  * to create a {@code BeanInfo} class
  33  * and provide explicit information about the methods,
  34  * properties, events, and other features of your beans.
  35  * <p>
  36  * When developing your bean, you can implement
  37  * the bean features required for your application task
  38  * omitting the rest of the {@code BeanInfo} features.
  39  * They will be obtained through the automatic analysis
  40  * by using the low-level reflection of the bean methods
  41  * and applying standard design patterns.
  42  * You have an opportunity to provide additional bean information
  43  * through various descriptor classes.
  44  * <p>
  45  * See the {@link SimpleBeanInfo} class that is
  46  * a convenient basic class for {@code BeanInfo} classes.
  47  * You can override the methods and properties of
  48  * the {@code SimpleBeanInfo} class to define specific information.
  49  * <p>
  50  * See also the {@link Introspector} class to learn more about bean behavior.


  51  */
  52 public interface BeanInfo {
  53 
  54     /**
  55      * Returns the bean descriptor
  56      * that provides overall information about the bean,
  57      * such as its display name or its customizer.
  58      *
  59      * @return  a {@link BeanDescriptor} object,
  60      *          or {@code null} if the information is to
  61      *          be obtained through the automatic analysis
  62      */
  63     BeanDescriptor getBeanDescriptor();
  64 
  65     /**
  66      * Returns the event descriptors of the bean
  67      * that define the types of events fired by this bean.
  68      *
  69      * @return  an array of {@link EventSetDescriptor} objects,
  70      *          or {@code null} if the information is to




  31  * Use the {@code BeanInfo} interface
  32  * to create a {@code BeanInfo} class
  33  * and provide explicit information about the methods,
  34  * properties, events, and other features of your beans.
  35  * <p>
  36  * When developing your bean, you can implement
  37  * the bean features required for your application task
  38  * omitting the rest of the {@code BeanInfo} features.
  39  * They will be obtained through the automatic analysis
  40  * by using the low-level reflection of the bean methods
  41  * and applying standard design patterns.
  42  * You have an opportunity to provide additional bean information
  43  * through various descriptor classes.
  44  * <p>
  45  * See the {@link SimpleBeanInfo} class that is
  46  * a convenient basic class for {@code BeanInfo} classes.
  47  * You can override the methods and properties of
  48  * the {@code SimpleBeanInfo} class to define specific information.
  49  * <p>
  50  * See also the {@link Introspector} class to learn more about bean behavior.
  51  *
  52  * @since 1.1
  53  */
  54 public interface BeanInfo {
  55 
  56     /**
  57      * Returns the bean descriptor
  58      * that provides overall information about the bean,
  59      * such as its display name or its customizer.
  60      *
  61      * @return  a {@link BeanDescriptor} object,
  62      *          or {@code null} if the information is to
  63      *          be obtained through the automatic analysis
  64      */
  65     BeanDescriptor getBeanDescriptor();
  66 
  67     /**
  68      * Returns the event descriptors of the bean
  69      * that define the types of events fired by this bean.
  70      *
  71      * @return  an array of {@link EventSetDescriptor} objects,
  72      *          or {@code null} if the information is to