Serializable
, Cloneable
, DescriptorRead
, OpenMBeanParameterInfo
public class OpenMBeanParameterInfoSupport extends MBeanParameterInfo implements OpenMBeanParameterInfo
description, name
Constructor | Description |
---|---|
OpenMBeanParameterInfoSupport |
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 . |
OpenMBeanParameterInfoSupport |
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 . |
OpenMBeanParameterInfoSupport |
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 . |
OpenMBeanParameterInfoSupport |
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 . |
OpenMBeanParameterInfoSupport |
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 . |
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals |
Compares the specified obj parameter with this
OpenMBeanParameterInfoSupport instance for equality. |
Object |
getDefaultValue() |
Returns the default value for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise. |
Set |
getLegalValues() |
Returns an unmodifiable Set of legal values for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise. |
Comparable |
getMaxValue() |
Returns the maximal value for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise. |
Comparable |
getMinValue() |
Returns the minimal value for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise. |
OpenType |
getOpenType() |
Returns the open type for the values of the parameter described by this OpenMBeanParameterInfoSupport instance. |
boolean |
hasDefaultValue() |
Returns true if this
OpenMBeanParameterInfoSupport instance specifies a non-null default value for the described parameter, false otherwise. |
int |
hashCode() |
Returns the hash code value for this
OpenMBeanParameterInfoSupport instance. |
boolean |
hasLegalValues() |
Returns true if this
OpenMBeanParameterInfoSupport instance specifies a non-null set of legal values for the described parameter, false otherwise. |
boolean |
hasMaxValue() |
Returns true if this
OpenMBeanParameterInfoSupport instance specifies a non-null maximal value for the described parameter, false otherwise. |
boolean |
hasMinValue() |
Returns true if this
OpenMBeanParameterInfoSupport instance specifies a non-null minimal value for the described parameter, false otherwise. |
boolean |
isValue |
Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance. |
String |
toString() |
Returns a string representation of this OpenMBeanParameterInfoSupport instance. |
clone, getType
getDescription, getDescriptor, getName
getDescription, getName
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)
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
.name
- cannot be a null or empty string.description
- cannot be a null or empty string.openType
- cannot be null.IllegalArgumentException
- if name
or
description
are null or empty string, or openType
is null.public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
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.
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.IllegalArgumentException
- if name
or
description
are null or empty string, or openType
is null, or the descriptor entries are invalid as described in the package description.public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue) throws OpenDataException
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
.T
- allows the compiler to check that the defaultValue
, if non-null, has the correct Java type for the given openType
.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 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.IllegalArgumentException
- if name
or
description
are null or empty string, or openType
is null.OpenDataException
- if defaultValue
is not a valid value for the specified openType
, or
defaultValue
is non null and openType
is an
ArrayType
or a TabularType
.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.
T
- allows the compiler to check that the
defaultValue
and legalValues
, if non-null, have the correct Java type for the given openType
.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 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.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.IllegalArgumentException
- if name
or
description
are null or empty string, or openType
is null.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 and
openType
is an ArrayType
or a TabularType
, or legalValues
is non null and non empty and
openType
is an ArrayType
or a TabularType
, or legalValues
is non null and non empty and
defaultValue
is not contained in legalValues
.public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException
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
.T
- allows the compiler to check that the
defaultValue
, minValue
, and maxValue
, if non-null, have the correct Java type for the given
openType
.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 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.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.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.IllegalArgumentException
- if name
or
description
are null or empty string, or openType
is null.OpenDataException
- if defaultValue
,
minValue
or maxValue
is not a valid value for the specified openType
, or defaultValue
is non null and openType
is an ArrayType
or a
TabularType
, or both minValue
and maxValue
are non-null and minValue.compareTo(maxValue) > 0
is
true
, or both defaultValue
and minValue
are non-null and minValue.compareTo(defaultValue) > 0
is true
, or both defaultValue
and maxValue
are non-null and defaultValue.compareTo(maxValue) > 0
is true
.public OpenType<?> getOpenType()
OpenMBeanParameterInfoSupport
instance.getOpenType
in interface OpenMBeanParameterInfo
public Object getDefaultValue()
OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.getDefaultValue
in interface OpenMBeanParameterInfo
public Set<?> getLegalValues()
OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.getLegalValues
in interface OpenMBeanParameterInfo
public Comparable<?> getMinValue()
OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.getMinValue
in interface OpenMBeanParameterInfo
public Comparable<?> getMaxValue()
OpenMBeanParameterInfoSupport
instance, if specified, or null
otherwise.getMaxValue
in interface OpenMBeanParameterInfo
public boolean hasDefaultValue()
true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null default value for the described parameter, false
otherwise.hasDefaultValue
in interface OpenMBeanParameterInfo
public boolean hasLegalValues()
true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null set of legal values for the described parameter, false
otherwise.hasLegalValues
in interface OpenMBeanParameterInfo
public boolean hasMinValue()
true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null minimal value for the described parameter, false
otherwise.hasMinValue
in interface OpenMBeanParameterInfo
public boolean hasMaxValue()
true
if this
OpenMBeanParameterInfoSupport
instance specifies a non-null maximal value for the described parameter, false
otherwise.hasMaxValue
in interface OpenMBeanParameterInfo
public boolean isValue(Object obj)
obj
is a valid value for the parameter described by this OpenMBeanParameterInfo
instance.isValue
in interface OpenMBeanParameterInfo
obj
- the object to be tested.true
if obj
is a valid value for the parameter described by this OpenMBeanParameterInfo
instance, false
otherwise.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 the OpenMBeanParameterInfo
interface,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.
equals
in interface OpenMBeanParameterInfo
equals
in class MBeanParameterInfo
obj
- the object to be compared for equality with this OpenMBeanParameterInfoSupport
instance.true
if the specified object is equal to this OpenMBeanParameterInfoSupport
instance.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.
hashCode
in interface OpenMBeanParameterInfo
hashCode
in class Object
OpenMBeanParameterInfoSupport
instancepublic String toString()
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.
toString
in interface OpenMBeanParameterInfo
toString
in class Object
OpenMBeanParameterInfoSupport
instance.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/openmbean/OpenMBeanParameterInfoSupport.html