Annotation Type Description


  • @Documented
    @Target({METHOD,FIELD,TYPE})
    @Retention(RUNTIME)
    public @interface Description
    This annotation is applied to a method that takes no arguments and returns a value that is converted into a String for use in the ObjectName when an instance of the enclosing class is used to construct an open MBean.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The description to be applied to the annotated element.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String key
      Optional key to use in a resource bundle for this description.
    • Element Detail

      • value

        java.lang.String value
        The description to be applied to the annotated element. This value must not be empty. It can either be the actual string that is inserted into the MBean info class, or a key into a resource bundle associated with the ManagedObjectManager. If there is no bundle value associated with the key, or no resource bundle is specified, the value is used directly in the MBean info class.
      • key

        java.lang.String key
        Optional key to use in a resource bundle for this description. If present, a gmbal tool will generate a resource bundle that contains key=value taken from the description annotation.

        If this key is not present, the default key is given by the class name, if this annotation appears on a class, or the class name.method name if this annotation appears on a method. It is an error to use the default value for more than one method of the same name, except for setters and getters.

        Default:
        ""