| java.lang.Object
 javax.management.modelmbean.DescriptorSupport
| Constructor Summary | |
| public | DescriptorSupport()
Default constructor. | | public | DescriptorSupport(int initialSize)
Creates descriptor instance with a given initial size.
Parameters:
initialSize - initial size of the descriptor
throws:
MBeanException - this exception is never thrown but is declared herefor Sun RI API compatibility
throws:
RuntimeOperationsException - if the initialSize is zero or negative. | | public | DescriptorSupport(DescriptorSupport descriptor)
Copy constructor.
Parameters:
descriptor - the descriptor to be copied
throws:
RuntimeOperationsException - if descriptor is null. | | public | DescriptorSupport(String[] fieldNames, Object[] fieldValues)
Creates descriptor instance with given field names and values.if both field names and field
values array contain empty arrays, an empty descriptor is created.
None of the name entries in the field names array can be a null reference.
Field values may contain null references.
Parameters:
fieldNames - Contains names for the descriptor fields. | | public | DescriptorSupport(String[] fields)
| | public | DescriptorSupport(String xmlString)
Descriptor constructor taking an XML String. |
| Method Summary | |
| public synchronized Object | clone()
| | public String[] | getFieldNames()
Returns string array of fields names. | | public Object | getFieldValue(String inFieldName)
| | public Object[] | getFieldValues(String[] fieldNames)
Returns all the field values in the descriptor as an array of Objects. | | public String[] | getFields()
Returns String array of fields in the format fieldName=fieldValue. | | public boolean | isValid()
Returns true if all of the fields have legal values given their names.
This implementation does not support interopreating with a directory or lookup service.
Thus, conforming to the specification, no checking is done on the "export" field.
Otherwise this implementation returns false if:
- name and descriptorType fieldNames are not defined, or null, or empty, or not String
- class, role, getMethod, setMethod fieldNames, if defined, are null or not String
- persistPeriod, currencyTimeLimit, lastUpdatedTimeStamp, lastReturnedTimeStamp if defined, are null, or not a Numeric String or not a Numeric Value >= -1
- log fieldName, if defined, is null, or not a Boolean or not a String with value "t", "f", "true", "false". | | public void | removeField(String fieldName)
| | public void | setField(String inFieldName, Object fieldValue)
| | 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.
Array sizes must match. | | public String | toString()
| | public String | toXMLString()
Returns an XML String representing the descriptor. |
| DescriptorSupport | | public DescriptorSupport()(Code) | | Default constructor.
|
| DescriptorSupport | | public DescriptorSupport(int initialSize) throws MBeanException(Code) | | Creates descriptor instance with a given initial size.
Parameters:
initialSize - initial size of the descriptor
throws:
MBeanException - this exception is never thrown but is declared herefor Sun RI API compatibility
throws:
RuntimeOperationsException - if the initialSize is zero or negative. The targetexception wrapped by this exception is an instace of IllegalArgumentException class. |
| DescriptorSupport | | public DescriptorSupport(DescriptorSupport descriptor)(Code) | | Copy constructor.
Parameters:
descriptor - the descriptor to be copied
throws:
RuntimeOperationsException - if descriptor is null. The target exception wrapped by thisexception is an instance of IllegalArgumentException class. |
| DescriptorSupport | | public DescriptorSupport(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException(Code) | | Creates descriptor instance with given field names and values.if both field names and field
values array contain empty arrays, an empty descriptor is created.
None of the name entries in the field names array can be a null reference.
Field values may contain null references.
Parameters:
fieldNames - Contains names for the descriptor fields. This array cannot containnull references. If both fieldNames and fieldValuesarguments contain null or empty array references then an empty descriptoris created. The size of the fieldNames array must match the size ofthe fieldValues array.
Parameters:
fieldValues - Contains values for the descriptor fields. Null references are allowed.
throws:
RuntimeOperationsException - if array sizes don't match |
| DescriptorSupport | | public DescriptorSupport(String[] fields)(Code) | | |
| DescriptorSupport | | public DescriptorSupport(String xmlString) throws MBeanException, RuntimeOperationsException, XMLParseException(Code) | | Descriptor constructor taking an XML String.
In this implementation, all field values will be created as Strings.
If the field values are not Strings, the programmer will have to reset or convert these fields correctly.
|
| getFieldNames | | public String[] getFieldNames()(Code) | | Returns string array of fields names. If the descriptor is empty, you will get an empty array.
|
| getFieldValues | | public Object[] getFieldValues(String[] fieldNames)(Code) | | 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.
|
| getFields | | public String[] getFields()(Code) | | Returns String array of fields in the format fieldName=fieldValue.
If there are no fields in the descriptor, then an empty String array is returned.
If a fieldValue is not a String then the toString() method is called on it and its returned value is used as
the value for the field enclosed in parenthesis.
|
| isValid | | public boolean isValid() throws RuntimeOperationsException(Code) | | Returns true if all of the fields have legal values given their names.
This implementation does not support interopreating with a directory or lookup service.
Thus, conforming to the specification, no checking is done on the "export" field.
Otherwise this implementation returns false if:
- name and descriptorType fieldNames are not defined, or null, or empty, or not String
- class, role, getMethod, setMethod fieldNames, if defined, are null or not String
- persistPeriod, currencyTimeLimit, lastUpdatedTimeStamp, lastReturnedTimeStamp if defined, are null, or not a Numeric String or not a Numeric Value >= -1
- log fieldName, if defined, is null, or not a Boolean or not a String with value "t", "f", "true", "false". These String values must not be case sensitive.
- visibility fieldName, if defined, is null, or not a Numeric String or a not Numeric Value >= 1 and <= 4
- severity fieldName, if defined, is null, or not a Numeric String or not a Numeric Value >= 1 and <= 5
- persistPolicy fieldName, if defined, is null, or not a following String :
- "OnUpdate", "OnTimer", "NoMoreOftenThan", "Always", "Never". These String values must not be case sensitive.
true if the values are legal.
throws:
RuntimeOperationsException - If the validity checking fails for any reason, this exception will be thrown. |
| setFields | | public void setFields(String[] fieldNames, Object[] fieldValues)(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 (by calling the method isValid)
If it is not valid, then an exception will be thrown. If the arrays are empty, then no change will take effect.
|
|
|