| javax.management.MBeanParameterInfo
 javax.management.openmbean.OpenMBeanParameterInfoSupport
| Constructor Summary | |
| public | OpenMBeanParameterInfoSupport(String name, String description, OpenType openType)
Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType and description. | | public | OpenMBeanParameterInfoSupport(String name, String description, OpenType openType, Object defaultValue)
Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType, description and defaultValue. | | public | OpenMBeanParameterInfoSupport(String name, String description, OpenType openType, Object defaultValue, Object[] legalValues)
Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType, description,
defaultValue and legalValues. | | public | OpenMBeanParameterInfoSupport(String name, String description, OpenType openType, Object defaultValue, Comparable minValue, Comparable maxValue)
Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType, description,
defaultValue, minValue and maxValue. |
| Method Summary | |
| public boolean | equals(Object obj)
Compares the specified obj parameter with this OpenMBeanParameterInfoSupport instance for equality. | | public Object | getDefaultValue()
Returns the default value for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise. | | public Set | getLegalValues()
Returns an unmodifiable Set of legal values for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise. | | public Comparable | getMaxValue()
Returns the maximal value for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise. | | public Comparable | getMinValue()
Returns the minimal value for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise. | | public OpenType | getOpenType()
Returns the open type for the values of the parameter described by this OpenMBeanParameterInfoSupport instance. | | public boolean | hasDefaultValue()
Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null default value
for the described parameter, false otherwise. | | public boolean | hasLegalValues()
Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null set of legal values
for the described parameter, false otherwise. | | public boolean | hasMaxValue()
Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null maximal value
for the described parameter, false otherwise. | | public boolean | hasMinValue()
Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null minimal value
for the described parameter, false otherwise. | | public int | hashCode()
Returns the hash code value for this OpenMBeanParameterInfoSupport instance. | | public boolean | isValue(Object obj)
Tests whether obj is a valid value for the parameter
described by this OpenMBeanParameterInfo instance.
Parameters:
obj - the object to be tested. | | public String | toString()
Returns a string representation of this OpenMBeanParameterInfoSupport instance. |
| OpenMBeanParameterInfoSupport | | public OpenMBeanParameterInfoSupport(String name, String description, OpenType openType)(Code) | | Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType and description.
Parameters:
name - cannot be a null or empty string.
Parameters:
description - cannot be a null or empty string.
Parameters:
openType - cannot be null.
throws:
IllegalArgumentException - if name or description are null or empty string,or openType is null. |
| OpenMBeanParameterInfoSupport | | public OpenMBeanParameterInfoSupport(String name, String description, OpenType openType, Object defaultValue) throws OpenDataException(Code) | | Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType, description and defaultValue.
Parameters:
name - cannot be a null or empty string.
Parameters:
description - cannot be a null or empty string.
Parameters:
openType - cannot be null.
Parameters:
defaultValue - must be a valid value for the openType specified for this parameter;default value not supported for ArrayType and TabularType;can be null, in which case it means that no default value is set.
throws:
IllegalArgumentException - if name or description are null or empty string,or openType is null.
throws:
OpenDataException - if defaultValue is not a valid value for the specified openType,or defaultValue is non null andopenType is an ArrayType or a TabularType. |
| OpenMBeanParameterInfoSupport | | public OpenMBeanParameterInfoSupport(String name, String description, OpenType openType, Object defaultValue, Object[] legalValues) throws OpenDataException(Code) | | Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType, description,
defaultValue and legalValues.
The contents of legalValues are internally dumped into an unmodifiable Set,
so subsequent modifications of the array referenced by legalValues have no impact on
this OpenMBeanParameterInfoSupport instance.
Parameters:
name - cannot be a null or empty string.
Parameters:
description - cannot be a null or empty string.
Parameters:
openType - cannot be null.
Parameters:
defaultValue - must be a valid value for the openType specified for this parameter;default value not supported for ArrayType and TabularType;can be null, in which case it means that no default value is set.
Parameters:
legalValues - each contained value must be valid for the openType specified for this parameter;legal values not supported for ArrayType and TabularType;can be null or empty.
throws:
IllegalArgumentException - if name or description are null or empty string,or openType is null.
throws:
OpenDataException - if defaultValue is not a valid value for the specified openType,or one value in legalValues is not valid for the specified openType,or defaultValue is non null andopenType is an ArrayType or a TabularType,or legalValues is non null and non empty andopenType is an ArrayType or a TabularType,or legalValues is non null and non empty anddefaultValue is not contained in legalValues. |
| OpenMBeanParameterInfoSupport | | public OpenMBeanParameterInfoSupport(String name, String description, OpenType openType, Object defaultValue, Comparable minValue, Comparable maxValue) throws OpenDataException(Code) | | Constructs an OpenMBeanParameterInfoSupport instance, which describes the parameter
used in one or more operations or constructors of a class of open MBeans,
with the specified name, openType, description,
defaultValue, minValue and maxValue.
It is possible to specify minimal and maximal values only for an open type
whose values are Comparable.
Parameters:
name - cannot be a null or empty string.
Parameters:
description - cannot be a null or empty string.
Parameters:
openType - cannot be null.
Parameters:
defaultValue - must be a valid value for the openType specified for this parameter;default value not supported for ArrayType and TabularType;can be null, in which case it means that no default value is set.
Parameters:
minValue - must be valid for the openType specified for this parameter;can be null, in which case it means that no minimal value is set.
Parameters:
maxValue - must be valid for the openType specified for this parameter;can be null, in which case it means that no maximal value is set.
throws:
IllegalArgumentException - if name or description are null or empty string,or openType is null.
throws:
OpenDataException - if defaultValue, minValue or maxValueis not a valid value for the specified openType,or defaultValue is non null andopenType is an ArrayType or a TabularType,or both minValue and maxValue are non-null andminValue.compareTo(maxValue) > 0 is true,or both defaultValue and minValue are non-null andminValue.compareTo(defaultValue) > 0 is true,or both defaultValue and maxValue are non-null anddefaultValue.compareTo(maxValue) > 0 is true. |
| equals | | public boolean equals(Object obj)(Code) | | Compares the specified obj parameter with this OpenMBeanParameterInfoSupport instance for equality.
Returns true if and only if all of the following statements are true:
- obj is non null,
- obj also implements the
OpenMBeanParameterInfo interface,
- their names are equal
- their open types are equal
- their default, min, max and legal values are equal.
This ensures that this equals method works properly for obj parameters which are
different implementations of the OpenMBeanParameterInfo interface.
Parameters:
obj - the object to be compared for equality with this OpenMBeanParameterInfoSupport instance; true if the specified object is equal to this OpenMBeanParameterInfoSupport instance. |
| getDefaultValue | | public Object getDefaultValue()(Code) | | Returns the default value for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise.
|
| getLegalValues | | public Set getLegalValues()(Code) | | Returns an unmodifiable Set of legal values for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise.
|
| getMaxValue | | public Comparable getMaxValue()(Code) | | Returns the maximal value for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise.
|
| getMinValue | | public Comparable getMinValue()(Code) | | Returns the minimal value for the parameter described by this OpenMBeanParameterInfoSupport instance,
if specified, or null otherwise.
|
| getOpenType | | public OpenType getOpenType()(Code) | | Returns the open type for the values of the parameter described by this OpenMBeanParameterInfoSupport instance.
|
| hasDefaultValue | | public boolean hasDefaultValue()(Code) | | Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null default value
for the described parameter, false otherwise.
|
| hasLegalValues | | public boolean hasLegalValues()(Code) | | Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null set of legal values
for the described parameter, false otherwise.
|
| hasMaxValue | | public boolean hasMaxValue()(Code) | | Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null maximal value
for the described parameter, false otherwise.
|
| hasMinValue | | public boolean hasMinValue()(Code) | | Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null minimal value
for the described parameter, false otherwise.
|
| hashCode | | public int hashCode()(Code) | | Returns the hash code value for this OpenMBeanParameterInfoSupport instance.
The hash code of an OpenMBeanParameterInfoSupport instance is the sum of the hash codes
of all elements of information used in equals comparisons
(ie: its name, its open type, and its default, min, max and legal values).
This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode()
for any two OpenMBeanParameterInfoSupport instances t1 and t2,
as required by the general contract of the method
Object.hashCode .
However, note that another instance of a class implementing the OpenMBeanParameterInfo interface
may be equal to this OpenMBeanParameterInfoSupport instance as defined by
OpenMBeanParameterInfoSupport.equals(java.lang.Object) ,
but may have a different hash code if it is calculated differently.
As OpenMBeanParameterInfoSupport instances are immutable, the hash code for this instance is calculated once,
on the first call to hashCode, and then the same value is returned for subsequent calls.
the hash code value for this OpenMBeanParameterInfoSupport instance |
| isValue | | public boolean isValue(Object obj)(Code) | | Tests whether obj is a valid value for the parameter
described by this OpenMBeanParameterInfo instance.
Parameters:
obj - the object to be tested. true if obj is a valid valuefor the parameter described by thisOpenMBeanParameterInfo instance,false otherwise. |
| toString | | public String toString()(Code) | | Returns a string representation of this OpenMBeanParameterInfoSupport instance.
The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanParameterInfoSupport),
the string representation of the name and open type of the described parameter,
and the string representation of its default, min, max and legal values.
As OpenMBeanParameterInfoSupport instances are immutable, the string representation for this instance is calculated once,
on the first call to toString, and then the same value is returned for subsequent calls.
a string representation of this OpenMBeanParameterInfoSupport instance |
|
|