javax.management.openmbean
public class OpenMBeanParameterInfoSupport extends MBeanParameterInfo implements OpenMBeanParameterInfo
description, name
Constructor and Description |
---|
OpenMBeanParameterInfoSupport(String name,
String desc,
OpenType<?> type)
Constructs a new
OpenMBeanParameterInfo using the specified
name, description and open type. |
OpenMBeanParameterInfoSupport(String name,
String desc,
OpenType<T> type,
T defaultValue)
Constructs a new
OpenMBeanParameterInfo using the
specified name, description, open type and default value. |
OpenMBeanParameterInfoSupport(String name,
String desc,
OpenType<T> type,
T defaultValue,
Comparable<T> minimumValue,
Comparable<T> maximumValue)
Constructs a new
OpenMBeanParameterInfo using the
specified name, description, open type, default, maximum and
minimum values. |
OpenMBeanParameterInfoSupport(String name,
String desc,
OpenType<T> type,
T defaultValue,
T[] legalValues)
Constructs a new
OpenMBeanParameterInfo using the
specified name, description, open type, default value and
set of legal values. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compares this parameter with the supplied object.
|
Object |
getDefaultValue()
Returns the default value of this parameter, or
null
if there is no default value. |
Set<?> |
getLegalValues()
Returns a
Set enumerating the legal values
of this parameter, or null if no such limited
set exists for this parameter. |
Comparable<?> |
getMaxValue()
Returns the maximum value of this parameter, or
null
if there is no maximum. |
Comparable<?> |
getMinValue()
Returns the minimum value of this parameter, or
null
if there is no minimum. |
OpenType<?> |
getOpenType()
Returns the open type instance which represents the type of this
parameter.
|
boolean |
hasDefaultValue()
Returns true if this parameter has a default value
(i.e. the value is non-null).
|
int |
hashCode()
Returns the hashcode of the parameter information as the sum of
the hashcodes of the name, open type, default value, maximum
value, minimum value and the set of legal values.
|
boolean |
hasLegalValues()
Returns true if there is a set of legal values for this
parameter (i.e. the value is non-null).
|
boolean |
hasMaxValue()
Returns true if there is a maximum value for this parameter
(i.e. the value is non-null).
|
boolean |
hasMinValue()
Returns true if there is a minimum value for this parameter.
|
boolean |
isValue(Object obj)
Returns true if the specified object is a valid value for
this parameter.
|
String |
toString()
Returns a textual representation of this instance.
|
clone, getType
getDescription, getName
finalize, getClass, notify, notifyAll, wait, wait, wait
getDescription, getName
public OpenMBeanParameterInfoSupport(String name, String desc, OpenType<?> type)
OpenMBeanParameterInfo
using the specified
name, description and open type. None of these values may be
null
and the name and description may not be equal
to the empty string.name
- the name of the parameter.desc
- a description of the parameter.type
- the open type of the parameter.IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.public OpenMBeanParameterInfoSupport(String name, String desc, OpenType<T> type, T defaultValue) throws OpenDataException
OpenMBeanParameterInfo
using the
specified name, description, open type and default value. The
name, description and open type cannot be null
and
the name and description may not be equal to the empty string.
The default value may be null
. If non-null, it must
be a valid value of the given open type. Default values are not
applicable to the open types, ArrayType
and TabularType
.name
- the name of the parameter.desc
- a description of the parameter.type
- the open type of the parameter.defaultValue
- the default value of the parameter.IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.OpenDataException
- if defaultValue is non-null
and is either not a value of the given
open type or the open type is an instance
of ArrayType
or TabularType
.
public OpenMBeanParameterInfoSupport(String name, String desc, OpenType<T> type, T defaultValue, Comparable<T> minimumValue, Comparable<T> maximumValue) throws OpenDataException
Constructs a new OpenMBeanParameterInfo
using the
specified name, description, open type, default, maximum and
minimum values. The name, description and open type cannot be
null
and the name and description may not be equal
to the empty string. The default, maximum and minimum values may
be null
. The following conditions apply when the
parameters mentioned are non-null:
ArrayType
and TabularType
.minValue.compareTo(maxValue) <= 0
.minValue.compareTo(defaultValue) <= 0
.defaultValue.compareTo(maxValue) <= 0
.name
- the name of the parameter.desc
- a description of the parameter.type
- the open type of the parameter.defaultValue
- the default value of the parameter, or null
.minimumValue
- the minimum value of the parameter, or null
.maximumValue
- the maximum value of the parameter, or null
.IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.OpenDataException
- if any condition in the list above is broken.public OpenMBeanParameterInfoSupport(String name, String desc, OpenType<T> type, T defaultValue, T[] legalValues) throws OpenDataException
Constructs a new OpenMBeanParameterInfo
using the
specified name, description, open type, default value and
set of legal values. The name, description and open type cannot be
null
and the name and description may not be equal
to the empty string. The default, maximum and minimum values may
be null
. The following conditions apply when the
parameters mentioned are non-null:
ArrayType
and TabularType
.The legal values are copied from the array into a unmodifiable set, so future modifications to the array have no effect.
name
- the name of the parameter.desc
- a description of the parameter.type
- the open type of the parameter.defaultValue
- the default value of the parameter, or null
.legalValues
- the legal values of the parameter. May be
null
or an empty array.IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.OpenDataException
- if any condition in the list above is broken.public boolean equals(Object obj)
OpenMBeanParameterInfo
with an equal name and open type and the same default, minimum,
maximum and legal values.equals
in interface OpenMBeanParameterInfo
equals
in class MBeanParameterInfo
obj
- the object to compare.OpenMBeanParameterInfo
instance,
name.equals(object.getName())
,
openType.equals(object.getOpenType())
,
defaultValue.equals(object.getDefaultValue())
,
minValue.equals(object.getMinValue())
,
maxValue.equals(object.getMaxValue())
,
and legalValues.equals(object.getLegalValues())
.Object.hashCode()
public Object getDefaultValue()
null
if there is no default value.getDefaultValue
in interface OpenMBeanParameterInfo
null
if there is no default.public Set<?> getLegalValues()
Set
enumerating the legal values
of this parameter, or null
if no such limited
set exists for this parameter.getLegalValues
in interface OpenMBeanParameterInfo
null
if no such
set exists.public Comparable<?> getMaxValue()
null
if there is no maximum.getMaxValue
in interface OpenMBeanParameterInfo
null
if none exists.public Comparable<?> getMinValue()
null
if there is no minimum.getMinValue
in interface OpenMBeanParameterInfo
null
if none exists.public OpenType<?> getOpenType()
getOpenType
in interface OpenMBeanParameterInfo
public boolean hasDefaultValue()
hasDefaultValue
in interface OpenMBeanParameterInfo
public int hashCode()
Returns the hashcode of the parameter information as the sum of the hashcodes of the name, open type, default value, maximum value, minimum value and the set of legal values.
As instances of this class are immutable, the hash code is computed just once for each instance and reused throughout its life.
hashCode
in interface OpenMBeanParameterInfo
hashCode
in class MBeanParameterInfo
Object.equals(Object)
,
System.identityHashCode(Object)
public boolean hasLegalValues()
hasLegalValues
in interface OpenMBeanParameterInfo
public boolean hasMaxValue()
hasMaxValue
in interface OpenMBeanParameterInfo
public boolean hasMinValue()
hasMinValue
in interface OpenMBeanParameterInfo
public boolean isValue(Object obj)
isValue
in interface OpenMBeanParameterInfo
obj
- the object to test.obj
is a valid value for this
parameter.public String toString()
Returns a textual representation of this instance. This
is constructed using the class name
(javax.management.openmbean.OpenMBeanParameterInfo
)
along with the name, open type, default, minimum, maximum
and legal values of the parameter.
As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.
toString
in interface OpenMBeanParameterInfo
toString
in class MBeanParameterInfo
Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)