|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.management.modelmbean.DescriptorSupport
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.
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 |
public java.lang.String currClass
Constructor Detail |
public DescriptorSupport()
public DescriptorSupport(int initNumFields) throws MBeanException, RuntimeOperationsException
initNumFields
- The initial capacity of the Map that stores
the descriptor fields.public DescriptorSupport(DescriptorSupport inDescr)
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.RuntimeOperationsException
- for illegal value for inDescr.
inDescr cannot be null. If the descriptor fails for any
reason, this exception will be thrown.public DescriptorSupport(java.lang.String inStr) throws MBeanException, RuntimeOperationsException, XMLParseException
inStr
- - An XML-formatted string used to populate this Descriptorpublic DescriptorSupport(java.lang.String[] fieldNames, java.lang.Object[] fieldValues) throws RuntimeOperationsException
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.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.public DescriptorSupport(java.lang.String[] fields)
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.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 |
public java.lang.Object getFieldValue(java.lang.String fieldName) throws RuntimeOperationsException
getFieldValue
in interface Descriptor
fieldName
- The field name in question; if not found, null is returned.RuntimeOperationsException
- for illegal value for field name.public void setField(java.lang.String fieldName, java.lang.Object fieldValue) throws RuntimeOperationsException
setField
in interface Descriptor
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.RuntimeOperationsException
- for illegal value for
field name or field value.public java.lang.String[] getFields()
getFields
in interface Descriptor
public java.lang.String[] getFieldNames()
getFieldNames
in interface Descriptor
public java.lang.Object[] getFieldValues(java.lang.String[] fieldNames)
getFieldValues
in interface Descriptor
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.public void removeField(java.lang.String fieldName)
removeField
in interface Descriptor
fieldName
- String name of the field to be removed. If the field
is not found no exception is thrown.public void setFields(java.lang.String[] fieldNames, java.lang.Object[] fieldValues) throws RuntimeOperationsException
setFields
in interface Descriptor
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.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.public java.lang.Object clone() throws RuntimeOperationsException
clone
in interface Descriptor
clone
in class java.lang.Object
RuntimeOperationsException
- for illegal value for field Names
or field Values. If the descriptor construction fails for
any reason, this exception will be thrown.public boolean isValid() throws RuntimeOperationsException
isValid
in interface Descriptor
RuntimeOperationsException
- If the validity checking fails
for any reason, this exception will be thrown.public java.lang.String toXMLString()
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.public java.lang.String toString()
toString
in class java.lang.Object
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 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |