1 /*
   2  * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.swing;
  26 
  27 import java.lang.annotation.Retention;
  28 import java.lang.annotation.Target;
  29 
  30 import static java.lang.annotation.ElementType.TYPE;
  31 import static java.lang.annotation.RetentionPolicy.RUNTIME;
  32 
  33 /**
  34  * An annotation used to specify some swing-related information
  35  * for the automatically generated {@code BeanInfo} classes.
  36  * This annotation is not used if the annotated class
  37  * has a corresponding user-defined {@code BeanInfo} class,
  38  * which does not imply the automatic analysis.
  39  * <p>
  40  * The {@code isContainer} {@link java.beans.BeanDescriptor#getValue
  41  * feature attribute} was introduced primarily for the Swing library.
  42  * All Swing components extend the {@link java.awt.Container Container}
  43  * class by design, so the builder tool assumes that all Swing components
  44  * are containers.  The {@link java.beans.BeanInfo BeanInfo} classes
  45  * with the {@code isContainer} attribute allow to directly specify
  46  * whether a Swing component is a container or not.
  47  *
  48  * @since 9
  49  *
  50  * @author Sergey A. Malenkov
  51  */
  52 @Target({TYPE})
  53 @Retention(RUNTIME)
  54 public @interface SwingContainer {
  55     /**
  56      * The value that indicates whether the annotated class can be used
  57      * as a container for other Swing components or not.
  58      *
  59      * @return {@code true} if the annotated class is a Swing container;
  60      *         {@code false} otherwise.
  61      */
  62     boolean value() default true;
  63 
  64     /**
  65      * The name of the getter method in the annotated class,
  66      * which returns the corresponding Swing container,
  67      * if it is not recommended to add subcomponents
  68      * to the annotated class directly.
  69      *
  70      * @return the name of the getter method in the annotated class,
  71      *         which returns the corresponding Swing container,
  72      *         or an empty string if the method name is not set.
  73      */
  74     String delegate() default "";
  75 }