XMOJO 5 API Docs

javax.management.modelmbean
Class DescriptorSupport

java.lang.Object
  |
  +--javax.management.modelmbean.DescriptorSupport
All Implemented Interfaces:
Descriptor, java.io.Serializable

public class DescriptorSupport
extends java.lang.Object
implements Descriptor

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.

See Also:
Serialized Form

Field Summary
 java.lang.String currClass
           
 
Constructor Summary
DescriptorSupport()
          Descriptor default constructor.
DescriptorSupport(DescriptorSupport inDescr)
          Descriptor constructor taking a Descriptor as parameter.
DescriptorSupport(int initNumFields)
          Descriptor constructor.
DescriptorSupport(java.lang.String inStr)
          Descriptor constructor taking an XML String.
DescriptorSupport(java.lang.String[] fields)
          Constructor taking fields in the fieldName=fieldValue format.
DescriptorSupport(java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
          Constructor taking field names and field values.
 
Method Summary
 java.lang.Object clone()
          Returns a new Descriptor which is a duplicate of the Descriptor.
 java.lang.String[] getFieldNames()
          Returns all the fields names in the descriptor.
 java.lang.String[] getFields()
          Returns all of the fields contained in this descriptor as a string array.
 java.lang.Object getFieldValue(java.lang.String fieldName)
          Returns the value for a specific fieldname.
 java.lang.Object[] getFieldValues(java.lang.String[] fieldNames)
          Returns all the field values in the descriptor as an array of Objects.
 boolean isValid()
          Returns true if fieldValues are checked to be sure they are legal for the fieldNames.
 void removeField(java.lang.String fieldName)
          Removes a field from the descriptor
 void setField(java.lang.String fieldName, java.lang.Object fieldValue)
          Sets the value for a specific fieldname.
 void setFields(java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
          Sets all Fields in the list to the new value in with the same index in the fieldValue array.
 java.lang.String toString()
          A human readable string representing the descriptor.
 java.lang.String toXMLString()
          This method returns the XML which represents the descriptor.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

currClass

public java.lang.String currClass
Constructor Detail

DescriptorSupport

public DescriptorSupport()
Descriptor default constructor.

DescriptorSupport

public DescriptorSupport(int initNumFields)
                  throws MBeanException,
                         RuntimeOperationsException
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 stores the descriptor fields.

DescriptorSupport

public DescriptorSupport(DescriptorSupport inDescr)
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 constructed descriptor. If it is null or contains no descriptor fields, an empty Descriptor will be created.
Throws:
RuntimeOperationsException - for illegal value for inDescr. inDescr cannot be null. If the descriptor fails for any reason, this exception will be thrown.

DescriptorSupport

public DescriptorSupport(java.lang.String inStr)
                  throws MBeanException,
                         RuntimeOperationsException,
                         XMLParseException
Descriptor constructor taking an XML String. This method is part of this implementation and not required by the JMX Specification.
Parameters:
inStr - - An XML-formatted string used to populate this Descriptor

DescriptorSupport

public DescriptorSupport(java.lang.String[] fieldNames,
                         java.lang.Object[] fieldValues)
                  throws RuntimeOperationsException
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 this array can be null.
fieldValues - Object array of the corresponding field values. Elements of the array can be null. The fieldValue must be valid for the fieldName. Note: array sizes of parameters should match. If both arrays are null or empty, then an empty descriptor is created. No exception is thrown.
Throws:
RuntimeOperationsException - for illegal value for field Names 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(java.lang.String[] fields)
Constructor taking fields in the fieldName=fieldValue format.
Parameters:
fields - String array of with each element containing a field name and value. If this array is null or empty, then the default constructor will be executed. Null strings or empty strings will be ignored. Note: each string should be of the form fieldName=fieldValue, with no imbedded blanks or other punctuation.
Throws:
RuntimeOperationsException - for illegal value for field Names or field Values. The field must contain an "=". "=fieldValue", "fieldName", and "fieldValue" are illegal. FieldName cannot be null. "fieldName=" will cause the value to be null. If the descriptor construction fails for any reason, this exception will be thrown.
Method Detail

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws RuntimeOperationsException
Returns the value for a specific fieldname.
Specified by:
getFieldValue in interface Descriptor
Parameters:
fieldName - The field name in question; if not found, null is returned.
Returns:
This returns the field name of type Object
Throws:
RuntimeOperationsException - for illegal value for field name.

setField

public void setField(java.lang.String fieldName,
                     java.lang.Object fieldValue)
              throws RuntimeOperationsException
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.
Specified by:
setField in interface Descriptor
Parameters:
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.
Throws:
RuntimeOperationsException - for illegal value for field name or field value.

getFields

public java.lang.String[] getFields()
Returns all of the fields contained in this descriptor as a string array.
Specified by:
getFields in interface Descriptor
Returns:
String array of fields in the format fieldName=fieldValue. If the value of a field is not a String, then the toString method will be called on it and the returned value used as the value for the field in the returned array. Object values which are not Strings will be enclosed in parens. If the descriptor is empty, you will get an empty array.

getFieldNames

public java.lang.String[] getFieldNames()
Returns all the fields names in the descriptor.
Specified by:
getFieldNames in interface Descriptor
Returns:
String array of fields names. If the descriptor is empty, you will get an empty array.

getFieldValues

public java.lang.Object[] getFieldValues(java.lang.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.
Specified by:
getFieldValues in interface Descriptor
Parameters:
fieldNames - String array of the names of the fields that the values should be returned for. If the array is empty then an empty array will be returned. If the array is 'null' then all values will be returned. If a field name in the array does not exist, then null is returned for the matching array element being returned.
Returns:
Object array of field values. If the descriptor is empty, you will get an empty array.

removeField

public void removeField(java.lang.String fieldName)
Removes a field from the descriptor
Specified by:
removeField in interface Descriptor
Parameters:
fieldName - String name of the field to be removed. If the field is not found no exception is thrown.

setFields

public void setFields(java.lang.String[] fieldNames,
                      java.lang.Object[] fieldValues)
               throws RuntimeOperationsException
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.
Specified by:
setFields in interface Descriptor
Parameters:
fieldNames - String array of field names. The array and array elements cannot be null.
fieldValues - Object array of the corresponding field values. The array cannot be null. Elements of the array can be null.
Throws:
RuntimeOperationsException - for illegal value for field Names or field Values. Neither can be null. The array lengths must be equal. If the descriptor construction fails for any reason, this exception will be thrown.

clone

public java.lang.Object clone()
                       throws RuntimeOperationsException
Returns a new Descriptor which is a duplicate of the Descriptor.
Specified by:
clone in interface Descriptor
Overrides:
clone in class java.lang.Object
Returns:
This returns a duplicate copy of the Descriptor
Throws:
RuntimeOperationsException - for illegal value for field Names or field Values. If the descriptor construction fails for any reason, this exception will be thrown.

isValid

public boolean isValid()
                throws RuntimeOperationsException
Returns true if fieldValues are checked to be sure they are legal for the fieldNames.
Specified by:
isValid in interface Descriptor
Returns:
This returns true if the fieldValues checked are valid otherwise false
Throws:
RuntimeOperationsException - If the validity checking fails for any reason, this exception will be thrown.

toXMLString

public java.lang.String toXMLString()
This method returns the XML which represents the descriptor.
Returns:
an XML String representing the descriptor.The XML string will be formatted for each field with " NAME=name VALUE=fieldValue TYPE=String|Object|ClassName>". The format will be:
Throws:
RuntimeOperationsException - thrown for illegal value for field Names or field Values. If the XML formated string construction fails for any reason, this will be thrown.

toString

public java.lang.String toString()
A human readable string representing the descriptor. The string will be in the format of "fieldName=fieldValue,fieldName2=fieldValue2,..."
Overrides:
toString in class java.lang.Object
Returns:
The string representation of descriptor
Throws:
RuntimeOperationsException - for illegal value for field Names or field Values. If the descriptor string fails for any reason, this exception will be thrown.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.