ModelMBeanAttributeInfo

Class Overview

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
 

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.

Summary

[Expand] Inherited Fields
From class javax.management.MBeanFeatureInfo protected String description The human-readable description of the feature. protected String name The name of the feature.

[Expand] Inherited Methods
From class javax.management.MBeanAttributeInfo Object clone() Returns a shallow clone of this instance. boolean equals(Object o) Compare this MBeanAttributeInfo to another. String getType() Returns the class name of the attribute. int hashCode() Returns a hash code value for the object. boolean isIs() Indicates if this attribute has an "is" getter. boolean isReadable() Whether the value of the attribute can be read. boolean isWritable() Whether new values can be written to the attribute. String toString() Returns a string representation of the object.
From class javax.management.MBeanFeatureInfo boolean equals(Object o) Compare this MBeanFeatureInfo to another. String getDescription() Returns the human-readable description of the feature. Descriptor getDescriptor() Returns the descriptor for the feature. String getName() Returns the name of the feature. int hashCode() Returns a hash code value for the object.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.
From interface javax.management.DescriptorAccess abstract void setDescriptor(Descriptor inDescriptor) Sets Descriptor (full replace).
From interface javax.management.DescriptorRead abstract Descriptor getDescriptor() Returns a copy of Descriptor.