| javax.management.MBeanAttributeInfo javax.management.modelmbean.ModelMBeanAttributeInfo
ModelMBeanAttributeInfo | public class ModelMBeanAttributeInfo extends MBeanAttributeInfo implements DescriptorAccess,Cloneable(Code) | | 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 ProtocolMap interface: map of protocol names and protocol hints
persistPolicy : OnUpdate|OnTimer|NoMoreOftenThan|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
iterable : T - object value supports Iterable interface, F - does not support Iterable interface
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 and descriptorType fields.
|
Constructor Summary | |
public | ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters: name - The name of the attribute. Parameters: description - A human readable description of the attribute. | public | ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) Constructs a ModelMBeanAttributeInfo object.
Parameters: name - The name of the attribute. Parameters: description - A human readable description of the 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.
Parameters: name - The name of the attribute Parameters: type - The type or class name of the attribute Parameters: description - A human readable description of the attribute. Parameters: isReadable - True if the attribute has a getter method, false otherwise. Parameters: isWritable - True if the attribute has a setter method, false otherwise. Parameters: isIs - True if the attribute has an "is" getter, false otherwise. Parameters: descriptor - An instance of Descriptor containing the appropriatemetadata for this instance of the Attribute. | public | ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo) Constructs a new ModelMBeanAttributeInfo object from this
ModelMBeanAttributeInfo Object. |
Method Summary | |
public Object | clone() Creates and returns a new ModelMBeanAttributeInfo which is a
duplicate of this ModelMBeanAttributeInfo.
exception: RuntimeOperationsException - for illegal value for field Namesor field Values. | public Descriptor | getDescriptor() | public void | setDescriptor(Descriptor inDescriptor) Sets associated Descriptor (full replace) for the
ModelMBeanAttributeDescriptor. | public String | toString() |
ModelMBeanAttributeInfo | public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionException(Code) | | Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters: name - The name of the attribute. Parameters: description - A human readable description of the attribute. Optional. Parameters: getter - The method used for reading the attribute value.May be null if the property is write-only. Parameters: setter - The method used for writing the attribute value.May be null if the attribute is read-only. exception: IntrospectionException - There is a consistency problem inthe definition of this attribute. |
ModelMBeanAttributeInfo | public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) throws IntrospectionException(Code) | | Constructs a ModelMBeanAttributeInfo object.
Parameters: name - The name of the attribute. Parameters: description - A human readable description of the attribute. Optional. Parameters: getter - The method used for reading the attribute value.May be null if the property is write-only. Parameters: setter - The method used for writing the attribute value.May be null if the attribute is read-only. Parameters: descriptor - An instance of Descriptor containing the appropriatemetadata for this instance of the Attribute. If it is nullor invalid then a default desriptor will be created. exception: IntrospectionException - There is a consistency problem inthe definition of this attribute. |
ModelMBeanAttributeInfo | public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)(Code) | | Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters: name - The name of the attribute Parameters: type - The type or class name of the attribute Parameters: description - A human readable description of the attribute. Parameters: isReadable - True if the attribute has a getter method, false otherwise. Parameters: isWritable - True if the attribute has a setter method, false otherwise. Parameters: isIs - True if the attribute has an "is" getter, false otherwise. |
ModelMBeanAttributeInfo | public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)(Code) | | Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters: name - The name of the attribute Parameters: type - The type or class name of the attribute Parameters: description - A human readable description of the attribute. Parameters: isReadable - True if the attribute has a getter method, false otherwise. Parameters: isWritable - True if the attribute has a setter method, false otherwise. Parameters: isIs - True if the attribute has an "is" getter, false otherwise. Parameters: descriptor - An instance of Descriptor containing the appropriatemetadata for this instance of the Attribute. If it is nullor invalid then a default desriptor will be created. |
ModelMBeanAttributeInfo | public ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)(Code) | | Constructs a new ModelMBeanAttributeInfo object from this
ModelMBeanAttributeInfo Object. A default descriptor will be created.
Parameters: inInfo - the ModelMBeanAttributeInfo to be duplicated |
clone | public Object clone()(Code) | | Creates and returns a new ModelMBeanAttributeInfo which is a
duplicate of this ModelMBeanAttributeInfo.
exception: RuntimeOperationsException - for illegal value for field Namesor field Values. If the descriptor construction fails forany reason, this exception will be thrown. |
getDescriptor | public Descriptor getDescriptor()(Code) | | Gets a copy of the associated Descriptor for the ModelMBeanAttributeInfo
Descriptor associated with the ModelMBeanAttributeInfo object. |
setDescriptor | public void setDescriptor(Descriptor inDescriptor)(Code) | | Sets associated Descriptor (full replace) for the
ModelMBeanAttributeDescriptor. If the new Descriptor is null, then the
associated Descriptor reverts to a default descriptor. The Descriptor
is validated before it is assigned. If the new Descriptor is invalid,
then an IllegalArgumentException is thrown.
Parameters: Descriptor - inDescriptor - replaces the Descriptor associatedwith the ModelMBeanAttributeInfo |
toString | public String toString()(Code) | | Returns a human readable version of the ModelMBeanAttributeInfo instance
|
|
|