|
|||||||||
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.
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 the fields in the descriptor Specified by: getFields in interface Descriptor |
java.lang.Object |
getFieldValue(java.lang.String inFieldName)
Returns the string value for a specific fieldname Specified by:(We can't find a way to write 'Specified by' to generate a javadoc) getFieldValue in interface Descriptor |
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 Specified by: removeField in interface Descriptor |
void |
setField(java.lang.String inFieldName,
java.lang.Object fieldValue)
Sets the string 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()
Overrides: toString in class java.lang.Object |
java.lang.String |
toXMLString()
|
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)
inDesc
- 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.public DescriptorSupport(java.lang.String inStr) throws MBeanException, RuntimeOperationsException, XMLParseException
inStr
- An XML-formatted string used to populate this
Descriptor
The format will be: (INCOMPLETE)public 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.- 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.
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.Method Detail |
public java.lang.Object getFieldValue(java.lang.String inFieldName) throws RuntimeOperationsException
fieldName
- The field name in question;if not found, null
is returned.public void setField(java.lang.String inFieldName, java.lang.Object fieldValue) throws RuntimeOperationsException
String
- fieldName The field name to be set. Must not be
null or empty string.String
- fieldValue The field value to be set for the
field name. Can be null.public java.lang.String[] getFields()
public java.lang.String[] getFieldNames()
public java.lang.Object[] getFieldValues(java.lang.String[] fieldNames)
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 setFields(java.lang.String[] fieldNames, java.lang.Object[] fieldValues) throws RuntimeOperationsException
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.public java.lang.Object clone() throws RuntimeOperationsException
public void removeField(java.lang.String fieldName)
fieldName
- String name of the field to be removed. If
the field is not found no exception is thrown.public boolean isValid() throws RuntimeOperationsException
public java.lang.String toXMLString()
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |