Descriptor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> [ management overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.management.Descriptor

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management
Interface Descriptor

All Superinterfaces:: java.io.Serializable

public interface Descriptor
extends java.io.Serializable

This interface defines behavioral and runtime metadata for ModelMBeans. A descriptor is a set of name-value pairs.

The DescriptorAccess interface defines how to get and set Descriptors for a ModelMBean's metadata classes.

The implementation must implement the following constructors.

Descriptor() returns an empty descriptor.

Descriptor(Descriptor) returns a copy of the decriptor.

Descriptor(String[], Object[]) a constructor that verifies the field names include a descriptorType and that predefined fields contain valid values.

Version:: $Revision: 1.2 $

Method Summary

java.lang.Object clone()
          Returns a descriptor that is a duplicate of this one.

java.lang.String[] getFieldNames()
          Retrieves all the field names in this descriptor.

java.lang.String[] getFields()
          Retrieves all the fields in this descriptor.

java.lang.Object getFieldValue(java.lang.String fieldName)
          Retrieves the value of a field.

java.lang.Object[] getFieldValues(java.lang.String[] fieldNames)
          Retrieves all the field values for the passed field names.

boolean isValid()
          Checks to see that this descriptor is valid.

void removeField(java.lang.String fieldName)
          Remove a field from the descriptor.

void setField(java.lang.String fieldName, java.lang.Object fieldValue)
          Sets the value of a field.

void setFields(java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
          Set multiple fields in this descriptor.

Method Detail

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws RuntimeOperationsException

Retrieves the value of a field.

setField

public void setField(java.lang.String fieldName,
                     java.lang.Object fieldValue)
              throws RuntimeOperationsException

Sets the value of a field.

getFields

public java.lang.String[] getFields()

Retrieves all the fields in this descriptor. The format is fieldName=fieldValue for String values and fieldName=(fieldValue.toString()) for other value types.

getFieldNames

public java.lang.String[] getFieldNames()

Retrieves all the field names in this descriptor.

getFieldValues

public java.lang.Object[] getFieldValues(java.lang.String[] fieldNames)

Retrieves all the field values for the passed field names. The array of object values returned is in the same order as the field names passed to the method.

When a fieldName does not exist, the corresponding element of the returned array is null.

removeField

public void removeField(java.lang.String fieldName)

Remove a field from the descriptor.

setFields

public void setFields(java.lang.String[] fieldNames,
                      java.lang.Object[] fieldValues)
               throws RuntimeOperationsException

Set multiple fields in this descriptor. The field in the fieldNames array is set to the value of the corresponding fieldValues array. The two arrays must be the same size.

clone

public java.lang.Object clone()
                       throws RuntimeOperationsException

Returns a descriptor that is a duplicate of this one.

isValid

public boolean isValid()
                throws RuntimeOperationsException

Checks to see that this descriptor is valid.