com.caplin.management.jmx

Annotation Type JMXBeanAttribute

@Documented
@Retention(value=RUNTIME)
public @interface JMXBeanAttribute

Annotation used to mark and describe JMX bean attributes, by marking methods in a class. If only the getter is marked, the attribute is read-only. If only the setter is marked, the attribute write-only. if both methods are marked, then the attribute is read-write enabled. Description and name can be specified on either the setter or getter. The annotated method(s) has/have to be public and must follow the JMX specification for attributes. Attributes that are readable must have an annotated public method which starts with either 'get' or 'is'. Attributes that are writeable must have an annotated public method which starts with 'set'. If the method does not start with any of these then it will be ignored by the JMXBeanWrapper when creating the bean.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description The description of this attribute, empty by default.
java.lang.String	name Name of this attribute, by default the standard Java bean syntax will be used to create a name out of the getter/setter name.

Element Detail

name

public abstract java.lang.String name

Name of this attribute, by default the standard Java bean syntax will be used to create a name out of the getter/setter name. N.B. only annotating methods starting with "get", "set", or "is" is an appropriate use of this annotation

Returns:

The name of the method.

Default:

""

description

public abstract java.lang.String description

The description of this attribute, empty by default.

Returns:

The attribute description.

Default:

""