1 /*
   2  * Copyright (c) 2007, 2010, 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 
  26 
  27 package com.sun.org.glassfish.gmbal ;
  28 
  29 import java.lang.annotation.Documented ;
  30 import java.lang.annotation.Target ;
  31 import java.lang.annotation.ElementType ;
  32 import java.lang.annotation.Retention ;
  33 import java.lang.annotation.RetentionPolicy ;
  34 
  35 /** This annotation defines an attribute in open MBean (ManagedObject) or
  36  * CompositeData (ManagedData).  It is useful in cases where the parent class
  37  * cannot be annotated (for example, Object.toString(), or a framework class
  38  * that must be extended
  39  * but cannot be modified).  The attribute id is defined in the annotation, and
  40  * it is implemented by the methods inherited by the Managed entity.
  41  * <p>
  42  * An example of a use of this is to handle @ManagedData that inherits from
  43  * Collection<X>, and it is desired to display a read-only attribute containing
  44  * the elements of the Collection.  Simple add the annotation
  45  * <p>
  46  * @InheritedAttribute( methodName="iterator" )
  47  * <p>
  48  * to handle this case.  Note that this only supports read-only attributes.
  49  */
  50 @Documented
  51 @Target(ElementType.TYPE)
  52 @Retention(RetentionPolicy.RUNTIME)
  53 public @interface InheritedAttribute {
  54     /** The description of the attribute.  Can be a key to a resource
  55      * bundle for I18N support. Note that this needs a description, otherwise
  56      * the InheritedAttributes annotation won't work.  The Description
  57      * annotation is used in all other cases.  The description cannot be
  58      * empty.
  59      * @return The description.
  60      */
  61     String description() ;
  62 
  63     /** The name of the attribute,  This class must inherit a method whose name
  64      * corresponds to this id in one of the standard ways.
  65      * @return The ID.
  66      */
  67     String id() default "" ;
  68 
  69     /** The name of the method implementing this attribute.  At least one of
  70      * id and methodName must not be empty.  If only one is given, the other
  71      * is derived according to the extended attribute name rules.
  72      */
  73     String methodName() default "" ;
  74 }