ModelMBeanAttributeInfo JDK 1.6)

Description

public class ModelMBeanAttributeInfo

The ModelMBeanAttributeInfo object describes an attribute of the ModelMBean.

The ModelMBeanAttributeInfo object describes an attribute of the ModelMBean. It is a subclass of MBeanAttributeInfo with the addition of an associated Descriptor and an implementation of the DescriptorAccess interface.

The fields in the descriptor are defined, but not limited to, the following:

 name           : attribute name  
 descriptorType : must be "attribute"   
 value          : current value for attribute 
 default        : default value for attribute 
 displayName    : name of attribute to be used in displays 
 getMethod      : name of operation descriptor for get method  
 setMethod      : name of operation descriptor for set method 
 protocolMap    : object which implements the Descriptor interface: mappings must be appropriate for the attribute
                  and entries can be updated or augmented at runtime.
 persistPolicy  : OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never  
 persistPeriod  : seconds - frequency of persist cycle. Used when persistPolicy is"OnTimer" or "NoMoreOftenThan".  
 currencyTimeLimit : how long value is valid, <0 never, =0 always, >0 seconds
 lastUpdatedTimeStamp : when value was set  
 visibility     : 1-4 where 1: always visible 4: rarely visible  
 presentationString : xml formatted string to allow presentation of data

The default descriptor contains the name, descriptorType and displayName fields.

Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

The serialVersionUID of this class is 6181543027787327345L.

See also:

Constructors

public ModelMBeanAttributeInfo (ModelMBeanAttributeInfo inInfo)

Constructs a new ModelMBeanAttributeInfo object from this ModelMBeanAttributeInfo Object.

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

Constructs a ModelMBeanAttributeInfo object with a default descriptor.

Constructs a ModelMBeanAttributeInfo object with a default
descriptor. The Descriptor of the constructed
object will include fields contributed by any annotations
on the Method objects that contain the DescriptorKey meta-annotation.
Parameters:
- name - The name of the attribute.
- description - A human readable description of the attribute. Optional.
- 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.

public ModelMBeanAttributeInfo (String name, String description, Method getter, Method setter, Descriptor descriptor) throws IntrospectionException

Constructs a ModelMBeanAttributeInfo object.

Constructs a ModelMBeanAttributeInfo object. The Descriptor of the constructed object will include fields
contributed by any annotations on the Method
objects that contain the DescriptorKey
meta-annotation.
Parameters:
- name - The name of the attribute.
- description - A human readable description of the attribute. Optional.
- 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.
- descriptor - An instance of Descriptor containing the appropriate metadata for this instance of the Attribute. If it is null, then a default descriptor will be created. If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value.
Throws:
- IntrospectionException - There is a consistency problem in the definition of this attribute.
- RuntimeOperationsException - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "DescriptorType" is not equal to "attribute".

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

Constructs a ModelMBeanAttributeInfo object with a default descriptor.

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

Constructs a ModelMBeanAttributeInfo object with a default descriptor.

Methods

Hide/Show inherited methods

public Object clone () [Overrides MBeanAttributeInfo]

Creates and returns a new ModelMBeanAttributeInfo which is a duplicate of this ModelMBeanAttributeInfo.

public boolean equals (Object o) [Inherited From MBeanAttributeInfo]

Compare this MBeanAttributeInfo to another.

Compare this MBeanAttributeInfo to another.
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.
Parameters:
- o - the object to compare to.

public String getDescription () [Inherited From MBeanFeatureInfo]

Returns the human-readable description of the feature.

public Descriptor getDescriptor () [Overrides MBeanFeatureInfo]

Gets a copy of the associated Descriptor for the ModelMBeanAttributeInfo.

public String getName () [Inherited From MBeanFeatureInfo]

Returns the name of the feature.

public String getType () [Inherited From MBeanAttributeInfo]

Returns the class name of the attribute.

public int hashCode () [Inherited From MBeanAttributeInfo]

public boolean isIs () [Inherited From MBeanAttributeInfo]

Indicates if this attribute has an "is" getter.

public boolean isReadable () [Inherited From MBeanAttributeInfo]

Whether the value of the attribute can be read.

public boolean isWritable () [Inherited From MBeanAttributeInfo]

Whether new values can be written to the attribute.

public void setDescriptor (Descriptor inDescriptor) [Specified in DescriptorAccess]

Sets associated Descriptor (full replace) for the ModelMBeanAttributeDescriptor.

public String toString () [Overrides MBeanAttributeInfo]

Returns a human-readable version of the ModelMBeanAttributeInfo instance.