Package org.glassfish.admin.amx.annotation

Annotation Type ChildGetter

  • @Retention(RUNTIME)
@Documented
@Target(METHOD)
@Taxonomy(stability=NOT_AN_INTERFACE)
public @interface ChildGetter
    Used on an AMXProxy sub-interface only. Indicates that the method is a proxy-based method for getting a child or List/Set/Map of children; it doesn’t actually exist as an MBean attribute or method. This annotation should not be applied when the method or Attribute actually does exist. This annotation is generally needed only when there are arbitrary types of children that are not known in advance and/or methods do not exist for them (eg because of derivation such as with config MBeans).

    The proxy method to which the annotation is applied must be of one of the following forms, where the interface FooBar is a sub-interface of AMXProxy.

    • FooBar getFooBar(); // gets a singleton child
    • Set<FooBar> getFooBar(); // gets all FooBar
    • List<FooBar> getFooBar(); // gets all FooBar
    • Map<String,FooBar> getFooBar(); // gets all FooBar
    • FooBar[] getFooBar(); // gets all FooBar
    The child type is derived from the method name, but if the standard derivation would result in the incorrect type then the annotation must include type="child-type">, where "child-type" is the appropriate type.
    Author:
    Lloyd Chambers

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String type
      child type, derived automatically by default for the normal naming pattern

    • Element Detail

      • type

        String type
        child type, derived automatically by default for the normal naming pattern
        Default:
        ""