| java.lang.Object
 javax.management.modelmbean.DescriptorSupport
| DescriptorSupport | | public class DescriptorSupport implements Descriptor(Code) | | This class represents the metadata set for a ModelMBean element. A
descriptor is part of the ModelMBeanInfo, ModelMBeanNotificationInfo,
ModelMBeanAttributeInfo, ModelMBeanConstructorInfo, and ModelMBeanParameterInfo.
A descriptor consists of a collection of fields. Each field is in
fieldname=fieldvalue format. Field names are not case sensitive, case will
be preserved on field values.
All field names and values are not predefined. New fields can be defined
and added by any program. Some fields have been predefined for consistency
of implmentation and support by the ModelMBeanInfo ModelMBean*Info, and
ModelMBean classes.
By default the descriptor store size is 20 fields. This is configurable.
|
| Method Summary | |
| public Object | clone()
Returns a new Descriptor which is a duplicate of the Descriptor.
This returns a duplicate copy of the Descriptor
exception:
RuntimeOperationsException - for illegal value for field Namesor field Values. | | public String[] | getFieldNames()
Returns all the fields names in the descriptor.
String array of fields names. | | public Object | getFieldValue(String fieldName)
Returns the value for a specific fieldname.
Parameters:
fieldName - The field name in question; if not found, null is returned. | | public Object[] | getFieldValues(String[] fieldNames)
Returns all the field values in the descriptor as an array of Objects.
The retuned values are in the same order as the fieldNames String array
parameter.
Parameters:
fieldNames - String array of the names of the fields that thevalues should be returned for. | | public String[] | getFields()
Returns all of the fields contained in this descriptor as a string array.
String array of fields in the format fieldName=fieldValue.If the value of a field is not a String, then the toStringmethod will be called on it and the returned value usedas the value for the field in the returned array. | | public boolean | isValid()
Returns true if fieldValues are checked to be sure they are legal for
the fieldNames. | | public void | removeField(String fieldName)
Removes a field from the descriptor
Parameters:
fieldName - String name of the field to be removed. | | public void | setField(String fieldName, Object fieldValue)
Sets the value for a specific fieldname. | | public void | setFields(String[] fieldNames, Object[] fieldValues)
Sets all Fields in the list to the new value in with the same index in
the fieldValue array. | | public String | toString()
A human readable string representing the descriptor. | | public String | toXMLString()
This method returns the XML which represents the descriptor.
an XML String representing the descriptor.The XML string willbe formatted for each field with " NAME=nameVALUE=fieldValue TYPE=String|Object|ClassName>". |
| DEFAULT_NUM_FIELDS | | int DEFAULT_NUM_FIELDS(Code) | | |
| LAST_UPDATED_TIMESTAMP | | static String LAST_UPDATED_TIMESTAMP(Code) | | |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| DescriptorSupport | | public DescriptorSupport()(Code) | | Descriptor default constructor.
|
| DescriptorSupport | | public DescriptorSupport(int initNumFields) throws MBeanException, RuntimeOperationsException(Code) | | Descriptor constructor. Takes as parameter the initial capacity of the
Map that stores the descriptor fields.
Parameters:
initNumFields - The initial capacity of the Map that storesthe descriptor fields. |
| DescriptorSupport | | public DescriptorSupport(DescriptorSupport inDescr)(Code) | | Descriptor constructor taking a Descriptor as parameter. Creates a new
descriptor initialized to the values of the descriptor passed in parameter.
Parameters:
inDescr - the descriptor to be used to initialize the constructeddescriptor. If it is null or contains no descriptorfields, an empty Descriptor will be created.
exception:
RuntimeOperationsException - for illegal value for inDescr.inDescr cannot be null. If the descriptor fails for anyreason, this exception will be thrown. |
| DescriptorSupport | | public DescriptorSupport(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException(Code) | | Constructor taking field names and field values. The array and array
elements cannot be null.
Parameters:
fieldNames - String array of field names. No elements of thisarray can be null.
Parameters:
fieldValues - Object array of the corresponding field values.Elements of the array can be null. The fieldValue must bevalid for the fieldName.Note:array sizes of parameters should match. If both arraysare null or empty, then an empty descriptor is created.No exception is thrown.
exception:
RuntimeOperationsException - for illegal value for fieldNames or field Values. The array lengths must be equal.If the descriptor construction fails for any reason,this exception will be thrown. |
| DescriptorSupport | | public DescriptorSupport(String[] fields)(Code) | | Constructor taking fields in the fieldName=fieldValue format.
Parameters:
fields - String array of with each element containing a field nameand value. If this array is null or empty, then thedefault constructor will be executed. Null strings orempty strings will be ignored.Note:each string should be of the form fieldName=fieldValue,with no imbedded blanks or other punctuation.
exception:
RuntimeOperationsException - for illegal value for field Namesor field Values. The field must contain an "="."=fieldValue", "fieldName", and "fieldValue" are illegal.FieldName cannot be null. "fieldName=" will cause thevalue to be null. If the descriptor construction failsfor any reason, this exception will be thrown. |
| clone | | public Object clone() throws RuntimeOperationsException(Code) | | Returns a new Descriptor which is a duplicate of the Descriptor.
This returns a duplicate copy of the Descriptor
exception:
RuntimeOperationsException - for illegal value for field Namesor field Values. If the descriptor construction fails forany reason, this exception will be thrown. |
| getFieldNames | | public String[] getFieldNames()(Code) | | Returns all the fields names in the descriptor.
String array of fields names. If the descriptor is empty,you will get an empty array. |
| getFieldValues | | public Object[] getFieldValues(String[] fieldNames)(Code) | | Returns all the field values in the descriptor as an array of Objects.
The retuned values are in the same order as the fieldNames String array
parameter.
Parameters:
fieldNames - String array of the names of the fields that thevalues should be returned for. If the array is empty thenan empty array will be returned. If the array is 'null'then all values will be returned. If a field name in thearray does not exist, then null is returned for thematching array element being returned. Object array of field values. If the descriptor is empty,you will get an empty array. |
| getFields | | public String[] getFields()(Code) | | Returns all of the fields contained in this descriptor as a string array.
String array of fields in the format fieldName=fieldValue.If the value of a field is not a String, then the toStringmethod will be called on it and the returned value usedas the value for the field in the returned array. Objectvalues which are not Strings will be enclosed in parens.If the descriptor is empty, you will get an empty array. |
| isValid | | public boolean isValid() throws RuntimeOperationsException(Code) | | Returns true if fieldValues are checked to be sure they are legal for
the fieldNames.
This returns true if the fieldValues checked are valid otherwise false
exception:
RuntimeOperationsException - If the validity checking failsfor any reason, this exception will be thrown. |
| removeField | | public void removeField(String fieldName)(Code) | | Removes a field from the descriptor
Parameters:
fieldName - String name of the field to be removed. If the fieldis not found no exception is thrown. |
| setField | | public void setField(String fieldName, Object fieldValue) throws RuntimeOperationsException(Code) | | Sets the value for a specific fieldname. The field value will be
validated before it is set. If it is not valid, then an exception will
be thrown. This will modify an existing field or add a new field.
fieldName: The field name to be set. Cannot be null or empty. fieldValue: The field value to be set for the field name. Can be null.
exception:
RuntimeOperationsException - for illegal value forfield name or field value. |
| setFields | | public void setFields(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException(Code) | | Sets all Fields in the list to the new value in with the same index in
the fieldValue array. Array sizes must match. The field value will be
validated before it is set. If it is not valid, then an exception will
be thrown. If the arrays are empty, then no change will take effect.
Parameters:
fieldNames - String array of field names. The array and arrayelements cannot be null.
Parameters:
fieldValues - Object array of the corresponding field values.The array cannot be null. Elements of the array can be null.
exception:
RuntimeOperationsException - for illegal value for field Namesor field Values. Neither can be null. The array lengthsmust be equal. If the descriptor construction fails forany reason, this exception will be thrown. |
| toString | | public String toString()(Code) | | A human readable string representing the descriptor. The string will be
in the format of "fieldName=fieldValue,fieldName2=fieldValue2,..."
The string representation of descriptor
exception:
RuntimeOperationsException - for illegal value for field Namesor field Values. If the descriptor string fails for anyreason, this exception will be thrown. |
| toXMLString | | public String toXMLString()(Code) | | This method returns the XML which represents the descriptor.
an XML String representing the descriptor.The XML string willbe formatted for each field with " NAME=nameVALUE=fieldValue TYPE=String|Object|ClassName>". The formatwill be:
exception:
RuntimeOperationsException - thrown for illegal value for fieldNames or field Values. If the XML formated stringconstruction fails for any reason, this will be thrown. |
|
|