| javax.management.Descriptor
All known Subclasses: javax.management.modelmbean.DescriptorSupport,
| Descriptor | | public interface Descriptor extends Serializable(Code) | | 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 odf ModelMBean some fields have been predefined for consistency of implementation and support by the ModelMBeanInfo
ModelMBean*Info, and ModelMBean classes.
author:
Young Yang |
| Method Summary | |
| public Object | clone()
Returns a new Descriptor which is a duplicate of the Descriptor. | | 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. | | public String[] | getFields()
Returns all of the fields contained in this descriptor as a string array.
String array of fields in the format fieldName=fieldValueIf the value of a field is not a String, then the toString() methodwill be called on it and the returned value used as the value forthe 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)
| | public void | setField(String fieldName, Object fieldValue)
Sets the value for a specific fieldname. The field value will be validated before
it is set. | | 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. |
| 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 getan 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 the valuesshould be returned for. If the array is empty then an empty array will bereturned. If the array is 'null' then all values will be returned. If a fieldname in the array does not exist, then null is returned for the matching arrayelement being returned. Object array of field values. If the descriptor is empty, you will getan 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=fieldValueIf the value of a field is not a String, then the toString() methodwill be called on it and the returned value used as the value forthe field in the returned array. Object values which are not Stringswill be enclosed in parens. If the descriptor is empty, you will getan empty array. |
| 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 field is 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 for field 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 array elements 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 URLName or field Values.Niether can be null. The array lengths must be equal.If the descriptor construction fails for any reason, this exception will be thrown. |
|
|