Class OpenMBeanParameterInfoSupport
- java.lang.Object
-
- javax.management.MBeanFeatureInfo
-
- javax.management.MBeanParameterInfo
-
- javax.management.openmbean.OpenMBeanParameterInfoSupport
- All Implemented Interfaces:
-
Serializable
,Cloneable
,DescriptorRead
,OpenMBeanParameterInfo
public class OpenMBeanParameterInfoSupport extends MBeanParameterInfo implements OpenMBeanParameterInfo
Describes a parameter used in one or more operations or constructors of an open MBean.
- Since:
- 1.5
- See Also:
- Serialized Form
Field Summary
Fields declared in class javax.management.MBeanFeatureInfo
description, name
Constructor Summary
Constructor | Description |
---|---|
OpenMBeanParameterInfoSupport(String name,
String description,
OpenType<?> openType) | Constructs an |
OpenMBeanParameterInfoSupport(String name,
String description,
OpenType<?> openType,
Descriptor descriptor) | Constructs an |
OpenMBeanParameterInfoSupport(String name,
String description,
OpenType<T> openType,
T defaultValue) | Constructs an |
OpenMBeanParameterInfoSupport(String name,
String description,
OpenType<T> openType,
T defaultValue,
Comparable<T> minValue,
Comparable<T> maxValue) | Constructs an |
OpenMBeanParameterInfoSupport(String name,
String description,
OpenType<T> openType,
T defaultValue,
T[] legalValues) | Constructs an |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(Object obj) | Compares the specified |
Object | getDefaultValue() | Returns the default value for the parameter described by this |
Set<?> | getLegalValues() | Returns an unmodifiable Set of legal values for the parameter described by this |
Comparable<?> | getMaxValue() | Returns the maximal value for the parameter described by this |
Comparable<?> | getMinValue() | Returns the minimal value for the parameter described by this |
OpenType<?> | getOpenType() | Returns the open type for the values of the parameter described by this |
boolean | hasDefaultValue() | Returns |
int | hashCode() | Returns the hash code value for this |
boolean | hasLegalValues() | Returns |
boolean | hasMaxValue() | Returns |
boolean | hasMinValue() | Returns |
boolean | isValue(Object obj) | Tests whether |
String | toString() | Returns a string representation of this |
Methods declared in class javax.management.MBeanParameterInfo
clone, getType
Methods declared in class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
Methods declared in class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods declared in interface javax.management.openmbean.OpenMBeanParameterInfo
getDescription, getName
Constructor Detail
OpenMBeanParameterInfoSupport
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
.
- Parameters:
-
name
- cannot be a null or empty string. -
description
- cannot be a null or empty string. -
openType
- cannot be null. - Throws:
-
IllegalArgumentException
- ifname
ordescription
are null or empty string, oropenType
is null.
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
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 descriptor
.
The descriptor
can contain entries that will define the values returned by certain methods of this class, as explained in the package description.
- Parameters:
-
name
- cannot be a null or empty string. -
description
- cannot be a null or empty string. -
openType
- cannot be null. -
descriptor
- The descriptor for the parameter. This may be null which is equivalent to an empty descriptor. - Throws:
-
IllegalArgumentException
- ifname
ordescription
are null or empty string, oropenType
is null, or the descriptor entries are invalid as described in the package description. - Since:
- 1.6
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue) throws OpenDataException
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
.
- Type Parameters:
-
T
- allows the compiler to check that thedefaultValue
, if non-null, has the correct Java type for the givenopenType
. - Parameters:
-
name
- cannot be a null or empty string. -
description
- cannot be a null or empty string. -
openType
- cannot be null. -
defaultValue
- must be a valid value for theopenType
specified for this parameter; default value not supported forArrayType
andTabularType
; can be null, in which case it means that no default value is set. - Throws:
-
IllegalArgumentException
- ifname
ordescription
are null or empty string, oropenType
is null. -
OpenDataException
- ifdefaultValue
is not a valid value for the specifiedopenType
, ordefaultValue
is non null andopenType
is anArrayType
or aTabularType
.
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues) throws OpenDataException
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 copied, so subsequent modifications of the array referenced by legalValues
have no impact on this OpenMBeanParameterInfoSupport
instance.
- Type Parameters:
-
T
- allows the compiler to check that thedefaultValue
andlegalValues
, if non-null, have the correct Java type for the givenopenType
. - Parameters:
-
name
- cannot be a null or empty string. -
description
- cannot be a null or empty string. -
openType
- cannot be null. -
defaultValue
- must be a valid value for theopenType
specified for this parameter; default value not supported forArrayType
andTabularType
; can be null, in which case it means that no default value is set. -
legalValues
- each contained value must be valid for theopenType
specified for this parameter; legal values not supported forArrayType
andTabularType
; can be null or empty. - Throws:
-
IllegalArgumentException
- ifname
ordescription
are null or empty string, oropenType
is null. -
OpenDataException
- ifdefaultValue
is not a valid value for the specifiedopenType
, or one value inlegalValues
is not valid for the specifiedopenType
, ordefaultValue
is non null andopenType
is anArrayType
or aTabularType
, orlegalValues
is non null and non empty andopenType
is anArrayType
or aTabularType
, orlegalValues
is non null and non empty anddefaultValue
is not contained inlegalValues
.
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException
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
.
- Type Parameters:
-
T
- allows the compiler to check that thedefaultValue
,minValue
, andmaxValue
, if non-null, have the correct Java type for the givenopenType
. - Parameters:
-
name
- cannot be a null or empty string. -
description
- cannot be a null or empty string. -
openType
- cannot be null. -
defaultValue
- must be a valid value for theopenType
specified for this parameter; default value not supported forArrayType
andTabularType
; can be null, in which case it means that no default value is set. -
minValue
- must be valid for theopenType
specified for this parameter; can be null, in which case it means that no minimal value is set. -
maxValue
- must be valid for theopenType
specified for this parameter; can be null, in which case it means that no maximal value is set. - Throws:
-
IllegalArgumentException
- ifname
ordescription
are null or empty string, oropenType
is null. -
OpenDataException
- ifdefaultValue
,minValue
ormaxValue
is not a valid value for the specifiedopenType
, ordefaultValue
is non null andopenType
is anArrayType
or aTabularType
, or bothminValue
andmaxValue
are non-null andminValue.compareTo(maxValue) > 0
istrue
, or bothdefaultValue
andminValue
are non-null andminValue.compareTo(defaultValue) > 0
istrue
, or bothdefaultValue
andmaxValue
are non-null anddefaultValue.compareTo(maxValue) > 0
istrue
.
Method Detail
getOpenType
public OpenType<?> getOpenType()
Returns the open type for the values of the parameter described by this OpenMBeanParameterInfoSupport
instance.
- Specified by:
-
getOpenType
in interfaceOpenMBeanParameterInfo
- Returns:
- the open type.
getDefaultValue
public Object getDefaultValue()
Returns the default value for the parameter described by this OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.
- Specified by:
-
getDefaultValue
in interfaceOpenMBeanParameterInfo
- Returns:
- the default value.
getLegalValues
public Set<?> getLegalValues()
Returns an unmodifiable Set of legal values for the parameter described by this OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.
- Specified by:
-
getLegalValues
in interfaceOpenMBeanParameterInfo
- Returns:
- the set of legal values.
getMinValue
public Comparable<?> getMinValue()
Returns the minimal value for the parameter described by this OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.
- Specified by:
-
getMinValue
in interfaceOpenMBeanParameterInfo
- Returns:
- the minimum value.
getMaxValue
public Comparable<?> getMaxValue()
Returns the maximal value for the parameter described by this OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.
- Specified by:
-
getMaxValue
in interfaceOpenMBeanParameterInfo
- Returns:
- the maximum value.
hasDefaultValue
public boolean hasDefaultValue()
Returns true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null default value for the described parameter, false
otherwise.
- Specified by:
-
hasDefaultValue
in interfaceOpenMBeanParameterInfo
- Returns:
- true if there is a default value.
hasLegalValues
public boolean hasLegalValues()
Returns true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null set of legal values for the described parameter, false
otherwise.
- Specified by:
-
hasLegalValues
in interfaceOpenMBeanParameterInfo
- Returns:
- true if there is a set of legal values.
hasMinValue
public boolean hasMinValue()
Returns true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null minimal value for the described parameter, false
otherwise.
- Specified by:
-
hasMinValue
in interfaceOpenMBeanParameterInfo
- Returns:
- true if there is a minimum value.
hasMaxValue
public boolean hasMaxValue()
Returns true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null maximal value for the described parameter, false
otherwise.
- Specified by:
-
hasMaxValue
in interfaceOpenMBeanParameterInfo
- Returns:
- true if there is a maximum value.
isValue
public boolean isValue(Object obj)
Tests whether obj
is a valid value for the parameter described by this OpenMBeanParameterInfo
instance.
- Specified by:
-
isValue
in interfaceOpenMBeanParameterInfo
- Parameters:
-
obj
- the object to be tested. - Returns:
-
true
ifobj
is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance,false
otherwise.
equals
public boolean equals(Object obj)
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 theOpenMBeanParameterInfo
interface, - their names are equal
- their open types are equal
- their default, min, max and legal values are equal.
equals
method works properly for obj
parameters which are different implementations of the OpenMBeanParameterInfo
interface. If obj
also implements DescriptorRead
, then its getDescriptor()
method must also return the same value as for this object.
- Specified by:
-
equals
in interfaceOpenMBeanParameterInfo
- Overrides:
-
equals
in classMBeanParameterInfo
- Parameters:
-
obj
- the object to be compared for equality with thisOpenMBeanParameterInfoSupport
instance. - Returns:
-
true
if the specified object is equal to thisOpenMBeanParameterInfoSupport
instance. - See Also:
-
Object.hashCode()
,HashMap
hashCode
public int hashCode()
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, its default, min, max and legal values, and its Descriptor).
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 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.
- Specified by:
-
hashCode
in interfaceOpenMBeanParameterInfo
- Overrides:
-
hashCode
in classObject
- Returns:
- the hash code value for this
OpenMBeanParameterInfoSupport
instance - See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
toString
public String toString()
Returns a string representation of this OpenMBeanParameterInfoSupport
instance.
The string representation consists of the name of this class (i.e. javax.management.openmbean.OpenMBeanParameterInfoSupport
), the string representation of the name and open type of the described parameter, the string representation of its default, min, max and legal values and the string representation of its descriptor.
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.
- Specified by:
-
toString
in interfaceOpenMBeanParameterInfo
- Overrides:
-
toString
in classObject
- Returns:
- a string representation of this
OpenMBeanParameterInfoSupport
instance.