FileDocCategorySizeDatePackage
Descriptor.javaAPI DocJava SE 5 API6122Fri Aug 26 14:57:32 BST 2005javax.management

Descriptor

public interface Descriptor implements Cloneable, Serializable
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.

since
1.5

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Objectclone()
Returns a new Descriptor which is a duplicate of the Descriptor.

exception
RuntimeOperationsException for illegal value for field Names or field Values. If the descriptor construction fails for any reason, this exception will be thrown.

public java.lang.String[]getFieldNames()
Returns all the fields names in the descriptor.

return
String array of fields names. If the descriptor is empty, you will get an empty array.

public java.lang.ObjectgetFieldValue(java.lang.String fieldName)
Returns the value for a specific fieldname.

param
fieldName The field name in question; if not found, null is returned.
return
Object Field value.
exception
RuntimeOperationsException for illegal value for field name.

public java.lang.Object[]getFieldValues(java.lang.String[] fieldNames)
Returns all the field values in the descriptor as an array of Objects. The returned values are in the same order as the fieldNames String array parameter.

param
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.
return
Object array of field values. If the descriptor is empty, you will get an empty array.

public java.lang.String[]getFields()
Returns all of the fields contained in this descriptor as a string array.

return
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 parentheses. If the descriptor is empty, you will get an empty array.
see
#setFields

public booleanisValid()
Returns true if all of the fields have legal values given their names.

return
true if the values are legal.
exception
RuntimeOperationsException If the validity checking fails for any reason, this exception will be thrown.

public voidremoveField(java.lang.String fieldName)
Removes a field from the descriptor.

param
fieldName String name of the field to be removed. If the field is not found no exception is thrown.

public voidsetField(java.lang.String fieldName, java.lang.Object fieldValue)
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.

param
fieldName The field name to be set. Cannot be null or empty.
param
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.

public voidsetFields(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. 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.

param
fieldNames String array of field names. The array and array elements cannot be null.
param
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 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.
see
#getFields