001/* MXBean.java - Marks a management bean interface as an MXBean.
002   Copyright (C) 2007 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.management;
039
040import java.lang.annotation.Documented;
041import java.lang.annotation.Retention;
042import java.lang.annotation.Target;
043
044import static java.lang.annotation.RetentionPolicy.RUNTIME;
045import static java.lang.annotation.ElementType.TYPE;
046
047/**
048 * <p>
049 * An annotation used to explictly mark an interface
050 * as defining (or not defining) an {@link MXBean}.  By
051 * default, such beans are taken to be those whose interface
052 * has the suffix {@code "MXBean"}.  The presence of this
053 * annotation overrides this intuition.  The following
054 * interfaces would be classed as {@link MXBean}s:
055 * </p>
056 * <ul>
057 * <li>{@code public interface SomethingMXBean{}}</li>
058 * <li>{@code @MXBean public interface Someat{}}</li>
059 * <li>{@code @MXBean(true) public interface SomeatElse{}}</li>
060 * </ul>
061 * <p>The following would not:</p>
062 * <ul>
063 * <li>{@code public interface RandomInterface{}}</li>
064 * <li>{@code @MXBean(false) public interface SomethingMXBean{}}</li>
065 * </ul>
066 *
067 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
068 * @since 1.6
069 */
070@Documented @Retention(RUNTIME) @Target(TYPE)
071public @interface MXBean
072{
073
074  /**
075   * Returns true if the annotated interface
076   * is an {@link MXBean}.
077   *
078   * @return true if the interface is an {@link MXBean}.
079   */
080  boolean value();
081
082}