|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.management.MBeanFeatureInfo javax.management.MBeanAttributeInfo javax.management.modelmbean.ModelMBeanAttributeInfo
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 augmentted at runtime. 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 visibility : 1-4 where 1: always visible 4: rarely visible presentationString : xml formatted string to allow presentation of dataThe default descriptor contains the name, descriptorType and displayName fields.
Field Summary |
Fields inherited from class javax.management.MBeanFeatureInfo |
description, name |
Constructor Summary | |
ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)
Constructs a new ModelMBeanAttributeInfo object from this ModelMBeanAttributeInfo Object. |
|
ModelMBeanAttributeInfo(String name,
String description,
Method getter,
Method setter)
Constructs a ModelMBeanAttributeInfo object with a default descriptor. |
|
ModelMBeanAttributeInfo(String name,
String description,
Method getter,
Method setter,
Descriptor descriptor)
Constructs a ModelMBeanAttributeInfo object. |
|
ModelMBeanAttributeInfo(String name,
String type,
String description,
boolean isReadable,
boolean isWritable,
boolean isIs)
Constructs a ModelMBeanAttributeInfo object with a default descriptor. |
|
ModelMBeanAttributeInfo(String name,
String type,
String description,
boolean isReadable,
boolean isWritable,
boolean isIs,
Descriptor descriptor)
Constructs a ModelMBeanAttributeInfo object with a default descriptor. |
Method Summary | |
Object |
clone()
Creates and returns a new ModelMBeanAttributeInfo which is a duplicate of this ModelMBeanAttributeInfo. |
Descriptor |
getDescriptor()
Gets a copy of the associated Descriptor for the ModelMBeanAttributeInfo. |
void |
setDescriptor(Descriptor inDescriptor)
Sets associated Descriptor (full replace) for the ModelMBeanAttributeDescriptor. |
String |
toString()
Returns a human-readable version of the ModelMBeanAttributeInfo instance. |
Methods inherited from class javax.management.MBeanAttributeInfo |
equals, getType, hashCode, isIs, isReadable, isWritable |
Methods inherited from class javax.management.MBeanFeatureInfo |
getDescription, getName |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionException
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.
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
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.
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)
name
- The name of the attributetype
- The type or class name of the attributedescription
- 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 the attribute has an "is" getter, false otherwise.public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
name
- The name of the attributetype
- The type or class name of the attributedescription
- 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 the attribute has an "is" getter, false otherwise.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.
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(ModelMBeanAttributeInfo inInfo)
inInfo
- the ModelMBeanAttributeInfo to be duplicatedMethod Detail |
public Descriptor getDescriptor()
getDescriptor
in interface DescriptorAccess
setDescriptor(javax.management.Descriptor)
public void setDescriptor(Descriptor inDescriptor)
setDescriptor
in interface DescriptorAccess
inDescriptor
- replaces the Descriptor associated with the
ModelMBeanAttributeInfo
RuntimeOperationsException
- Wraps an
IllegalArgumentException for an invalid DescriptorgetDescriptor()
public Object clone()
clone
in class MBeanAttributeInfo
RuntimeOperationsException
- for illegal value for field Names or field Values.
If the descriptor construction fails for any reason, this exception will be thrown.public String toString()
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.