Constructor Summary

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.

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.

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.

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.

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.

Constructor Detail

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.

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.

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.

Type Parameters:

T - allows the compiler to check that the defaultValue,
if non-null, has the correct Java type for the given openType.

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 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.

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.

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 the defaultValue and legalValues, if non-null, have the
correct Java type for the given openType.

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 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.

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.

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.
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 the defaultValue, minValue, and maxValue, if
non-null, have the correct Java type for the given openType.

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 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.

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.

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.

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.