/*
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package java.beans;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

An annotation used to specify some class-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. 
Author:
Sergey A. Malenkov
See Also:
BeanInfo.getBeanDescriptor
Since:
9/**
 * An annotation used to specify some class-related information
 * for the automatically generated {@link BeanInfo} classes.
 * This annotation is not used if the annotated class
 * has a corresponding user-defined {@code BeanInfo} class,
 * which does not imply the automatic analysis.
 *
 * @see BeanInfo#getBeanDescriptor
 * @since 9
 *
 * @author Sergey A. Malenkov
 */
@Documented
@Target({TYPE})
@Retention(RUNTIME)
public @interface JavaBean {
    
The short description for the bean descriptor of the annotated class. 
Returns:
the bean description,
        or an empty string if the description is not set./**
     * The {@link BeanDescriptor#getShortDescription short description}
     * for the {@link BeanInfo#getBeanDescriptor bean descriptor}
     * of the annotated class.
     *
     * @return the bean description,
     *         or an empty string if the description is not set.
     */
    String description() default "";

    
The name of the default property is used to calculate its index in the array of properties defined in the annotated class. If the name is not set or the annotated class does not define a property with the specified name, the default property index will be calculated automatically by the Introspector depending on its state. 
Returns:
the name of the default property,
        or an empty string if the name is not set./**
     * The name of the default property is used to calculate its
     * {@link BeanInfo#getDefaultPropertyIndex index} in the
     * {@link BeanInfo#getPropertyDescriptors array} of properties
     * defined in the annotated class. If the name is not set or
     * the annotated class does not define a property
     * with the specified name, the default property index
     * will be calculated automatically by the
     * {@link Introspector} depending on its state.
     *
     * @return the name of the default property,
     *         or an empty string if the name is not set.
     */
    String defaultProperty() default "";

    
The name of the default event set is used to calculate its index in the array of event sets defined in the annotated class. If the name is not set or the annotated class does not define an event set with the specified name, the default event set index will be calculated automatically by the Introspector depending on its state. 
Returns:
the name of the default event set,
        or an empty string if the name is not set./**
     * The name of the default event set is used to calculate its
     * {@link BeanInfo#getDefaultEventIndex index} in the
     * {@link BeanInfo#getEventSetDescriptors array} of event sets
     * defined in the annotated class. If the name is not set or
     * the annotated class does not define an event set
     * with the specified name, the default event set index
     * will be calculated automatically by the
     * {@link Introspector} depending on its state.
     *
     * @return the name of the default event set,
     *         or an empty string if the name is not set.
     */
    String defaultEventSet() default "";
}