Annotation Type InheritedAttribute


  • @Documented
    @Target(TYPE)
    @Retention(RUNTIME)
    public @interface InheritedAttribute
    This annotation defines an attribute in open MBean (ManagedObject) or CompositeData (ManagedData). It is useful in cases where the parent class cannot be annotated (for example, Object.toString(), or a framework class that must be extended but cannot be modified). The attribute id is defined in the annotation, and it is implemented by the methods inherited by the Managed entity.

    An example of a use of this is to handle @ManagedData that inherits from Collection<X>, and it is desired to display a read-only attribute containing the elements of the Collection. Simple add the annotation

    @InheritedAttribute( methodName="iterator" )

    to handle this case. Note that this only supports read-only attributes.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String description
      The description of the attribute.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String id
      The name of the attribute, This class must inherit a method whose name corresponds to this id in one of the standard ways.
      java.lang.String methodName
      The name of the method implementing this attribute.
    • Element Detail

      • description

        java.lang.String description
        The description of the attribute. Can be a key to a resource bundle for I18N support. Note that this needs a description, otherwise the InheritedAttributes annotation won't work. The Description annotation is used in all other cases. The description cannot be empty.
        Returns:
        The description.
      • id

        java.lang.String id
        The name of the attribute, This class must inherit a method whose name corresponds to this id in one of the standard ways.
        Returns:
        The ID.
        Default:
        ""
      • methodName

        java.lang.String methodName
        The name of the method implementing this attribute. At least one of id and methodName must not be empty. If only one is given, the other is derived according to the extended attribute name rules.
        Default:
        ""