Source for javax.management.MXBean

   1: /* MXBean.java - Marks a management bean interface as an MXBean.
   2:    Copyright (C) 2007 Free Software Foundation
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management;
  39: 
  40: import java.lang.annotation.Documented;
  41: import java.lang.annotation.Retention;
  42: import java.lang.annotation.Target;
  43: 
  44: import static java.lang.annotation.RetentionPolicy.RUNTIME;
  45: import static java.lang.annotation.ElementType.TYPE;
  46: 
  47: /**
  48:  * <p>
  49:  * An annotation used to explictly mark an interface
  50:  * as defining (or not defining) an {@link MXBean}.  By
  51:  * default, such beans are taken to be those whose interface
  52:  * has the suffix {@code "MXBean"}.  The presence of this
  53:  * annotation overrides this intuition.  The following
  54:  * interfaces would be classed as {@link MXBean}s:
  55:  * </p>
  56:  * <ul>
  57:  * <li>{@code public interface SomethingMXBean{}}</li>
  58:  * <li>{@code @MXBean public interface Someat{}}</li>
  59:  * <li>{@code @MXBean(true) public interface SomeatElse{}}</li>
  60:  * </ul>
  61:  * <p>The following would not:</p>
  62:  * <ul>
  63:  * <li>{@code public interface RandomInterface{}}</li>
  64:  * <li>{@code @MXBean(false) public interface SomethingMXBean{}}</li>
  65:  * </ul>
  66:  *
  67:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  68:  * @since 1.6
  69:  */
  70: @Documented @Retention(RUNTIME) @Target(TYPE)
  71: public @interface MXBean
  72: {
  73: 
  74:   /**
  75:    * Returns true if the annotated interface
  76:    * is an {@link MXBean}.
  77:    *
  78:    * @return true if the interface is an {@link MXBean}.
  79:    */
  80:   boolean value();
  81: 
  82: }