|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents the behavioral metadata set for a JMX Element. For examples, 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.
All field names and values are not predefined. New fields can be defined and added by any program. In the case of ModelMBean some fields have been predefined for consistency of implementation and support by the ModelMBeanInfo ModelMBean*Info, and ModelMBean classes.
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. |
Method Detail |
public java.lang.Object getFieldValue(java.lang.String fieldName) throws RuntimeOperationsException
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
String
- fieldName: The field name to be set. Cannot be null or empty.Object
- 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()
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 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 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.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 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
RuntimeOperationsException
- If the validity checking 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 |