src/share/classes/java/beans/Visibility.java

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


  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 
  26 package java.beans;
  27 
  28 /**
  29  * Under some circumstances a bean may be run on servers where a GUI
  30  * is not available.  This interface can be used to query a bean to
  31  * determine whether it absolutely needs a gui, and to advise the
  32  * bean whether a GUI is available.
  33  * <p>
  34  * This interface is for expert developers, and is not needed
  35  * for normal simple beans.  To avoid confusing end-users we
  36  * avoid using getXXX setXXX design patterns for these methods.


  37  */
  38 
  39 public interface Visibility {
  40 
  41     /**
  42      * Determines whether this bean needs a GUI.
  43      *
  44      * @return True if the bean absolutely needs a GUI available in
  45      *          order to get its work done.
  46      */
  47     boolean needsGui();
  48 
  49     /**
  50      * This method instructs the bean that it should not use the Gui.
  51      */
  52     void dontUseGui();
  53 
  54     /**
  55      * This method instructs the bean that it is OK to use the Gui.
  56      */


  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 
  26 package java.beans;
  27 
  28 /**
  29  * Under some circumstances a bean may be run on servers where a GUI
  30  * is not available.  This interface can be used to query a bean to
  31  * determine whether it absolutely needs a gui, and to advise the
  32  * bean whether a GUI is available.
  33  * <p>
  34  * This interface is for expert developers, and is not needed
  35  * for normal simple beans.  To avoid confusing end-users we
  36  * avoid using getXXX setXXX design patterns for these methods.
  37  *
  38  * @since 1.1
  39  */
  40 
  41 public interface Visibility {
  42 
  43     /**
  44      * Determines whether this bean needs a GUI.
  45      *
  46      * @return True if the bean absolutely needs a GUI available in
  47      *          order to get its work done.
  48      */
  49     boolean needsGui();
  50 
  51     /**
  52      * This method instructs the bean that it should not use the Gui.
  53      */
  54     void dontUseGui();
  55 
  56     /**
  57      * This method instructs the bean that it is OK to use the Gui.
  58      */