javax.management
class MBeanAttributeInfo

java.lang.Object javax.management.MBeanFeatureInfo javax.management.MBeanAttributeInfo

All Implemented Interfaces:

Serializable, Cloneable, DescriptorRead

Direct Known Subclasses:

ModelMBeanAttributeInfo, OpenMBeanAttributeInfoSupport

Most common ways to construct:

MBeanInfo info = …;

MBeanAttributeInfo attInfo[] = info.getAttributes();

Based on 10 examples

 

HashMap attributeMap = …;
String attrName = …;

MBeanAttributeInfo info = (MBeanAttributeInfo)attributeMap.get(attrName);

Based on 8 examples

public class MBeanAttributeInfo
extends MBeanFeatureInfo
implements Cloneable

Describes an MBean attribute exposed for management. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.

MBeanAttributeInfo

public MBeanAttributeInfo(String name,
                          String description,
                          Method getter,
                          Method setter)
                   throws IntrospectionException

This constructor takes the name of a simple attribute, and Method objects for reading and writing the attribute. The {@link Descriptor} of the constructed object will include fields contributed by any annotations on the {@code Method} objects that contain the {@link DescriptorKey} meta-annotation.

Parameters:

name - The programmatic name of the attribute.

description - A human readable description of the attribute.

getter - The method used for reading the attribute value. May be null if the property is write-only.

setter - The method used for writing the attribute value. May be null if the attribute is read-only.

Throws:

IntrospectionException - There is a consistency problem in the definition of this attribute.

MBeanAttributeInfo

public MBeanAttributeInfo(String name,
                          String type,
                          String description,
                          boolean isReadable,
                          boolean isWritable,
                          boolean isIs)

Constructs an MBeanAttributeInfo object.

Parameters:

name - The name of the attribute.

type - The type or class name of the attribute.

description - A human readable description of the attribute.

isReadable - True if the attribute has a getter method, false otherwise.

isWritable - True if the attribute has a setter method, false otherwise.

isIs - True if this attribute has an "is" getter, false otherwise.

MBeanAttributeInfo

public MBeanAttributeInfo(String name,
                          String type,
                          String description,
                          boolean isReadable,
                          boolean isWritable,
                          boolean isIs,
                          Descriptor descriptor)

Constructs an MBeanAttributeInfo object.

Parameters:

name - The name of the attribute.

type - The type or class name of the attribute.

description - A human readable description of the attribute.

isReadable - True if the attribute has a getter method, false otherwise.

isWritable - True if the attribute has a setter method, false otherwise.

isIs - True if this attribute has an "is" getter, false otherwise.

descriptor - The descriptor for the attribute. This may be null which is equivalent to an empty descriptor.

clone

public Object clone()

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, cloning is chiefly of interest to subclasses.

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Compare this MBeanAttributeInfo to another.

Overrides:

equals in class MBeanFeatureInfo

Parameters:

o - the object to compare to.

Returns:

true if and only if o is an MBeanAttributeInfo such that its {@link #getName()}, {@link #getType()}, {@link #getDescription()}, {@link #isReadable()}, {@link #isWritable()}, and {@link #isIs()} values are equal (not necessarily identical) to those of this MBeanAttributeInfo.

getType

public String getType()

Returns the class name of the attribute.

Returns:

the class name.

hashCode

public int hashCode()

Overrides:

hashCode in class MBeanFeatureInfo

isIs

public boolean isIs()

Indicates if this attribute has an "is" getter.

Returns:

true if this attribute has an "is" getter.

isReadable

public boolean isReadable()

Whether the value of the attribute can be read.

Returns:

True if the attribute can be read, false otherwise.

isWritable

public boolean isWritable()

Whether new values can be written to the attribute.

Returns:

True if the attribute can be written to, false otherwise.

toString

public String toString()

Overrides:

toString in class Object