OpenMBeanParameterInfoSupport JDK 1.6)

Constructors

public OpenMBeanParameterInfoSupport (String name, String description, OpenType<Object> 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 - if {@code name} or {@code description} are null or empty string, or {@code openType} is null.

public OpenMBeanParameterInfoSupport (String name, String description, OpenType<Object> openType, Descriptor descriptor)

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.
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 {@code openType} specified for this parameter; default value not supported for {@code ArrayType} and {@code TabularType}; can be null, in which case it means that no default value is set.
- T - allows the compiler to check that the {@code defaultValue}, if non-null, has the correct Java type for the given {@code openType}.
Throws:
- IllegalArgumentException - if {@code name} or {@code description} are null or empty string, or {@code openType} is null.
- OpenDataException - if {@code defaultValue} is not a valid value for the specified {@code openType}, or {@code defaultValue} is non null and {@code openType} is an {@code ArrayType} or a {@code TabularType}.

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.
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 {@code openType} specified for this parameter; default value not supported for {@code ArrayType} and {@code TabularType}; can be null, in which case it means that no default value is set.
- minValue - must be valid for the {@code 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 {@code openType} specified for this parameter; can be null, in which case it means that no maximal value is set.
- T - allows the compiler to check that the {@code defaultValue}, {@code minValue}, and {@code maxValue}, if non-null, have the correct Java type for the given {@code openType}.
Throws:
- IllegalArgumentException - if {@code name} or {@code description} are null or empty string, or {@code openType} is null.
- OpenDataException - if {@code defaultValue}, {@code minValue} or {@code maxValue} is not a valid value for the specified {@code openType}, or {@code defaultValue} is non null and {@code openType} is an {@code ArrayType} or a {@code TabularType}, or both {@code minValue} and {@code maxValue} are non-null and {@code minValue.compareTo(maxValue) > 0} is {@code true}, or both {@code defaultValue} and {@code minValue} are non-null and {@code minValue.compareTo(defaultValue) > 0} is {@code true}, or both {@code defaultValue} and {@code maxValue} are non-null and {@code defaultValue.compareTo(maxValue) > 0} is {@code true}.

public OpenMBeanParameterInfoSupport (String name, String description, OpenType< T> openType, T defaultValue, T legalValues) throws OpenDataException

private OpenMBeanParameterInfoSupport (String name, String description, OpenType< T> openType, T defaultValue, T legalValues, Comparable< T> minValue, Comparable< T> maxValue) throws OpenDataException

Methods

Hide/Show inherited methods

public Object clone () [Inherited From MBeanParameterInfo]

Returns a shallow clone of this instance.

public boolean equals (Object obj) [Overrides MBeanParameterInfo] [Specified in OpenMBeanParameterInfo]

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.

If obj also implements DescriptorRead, then its getDescriptor() method must also return the same value as for this object.

Returns: {@code true} if the specified object is equal to this {@code OpenMBeanParameterInfoSupport} instance.
Parameters:
- obj - the object to be compared for equality with this {@code OpenMBeanParameterInfoSupport} instance.

public Object getDefaultValue () [Specified in OpenMBeanParameterInfo]

Returns the default value for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise.

public String getDescription () [Inherited From MBeanFeatureInfo]

Returns the human-readable description of the feature.

public Descriptor getDescriptor () [Inherited From MBeanFeatureInfo]

Returns the descriptor for the feature.

public Set<Object> getLegalValues () [Specified in OpenMBeanParameterInfo]

Returns an unmodifiable Set of legal values for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise.

public Comparable<Object> getMaxValue () [Specified in OpenMBeanParameterInfo]

Returns the maximal value for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise.

public Comparable<Object> getMinValue () [Specified in OpenMBeanParameterInfo]

Returns the minimal value for the parameter described by this OpenMBeanParameterInfoSupport instance, if specified, or null otherwise.

public String getName () [Inherited From MBeanFeatureInfo]

Returns the name of the feature.

public OpenType<Object> getOpenType () [Specified in OpenMBeanParameterInfo]

Returns the open type for the values of the parameter described by this OpenMBeanParameterInfoSupport instance.

public String getType () [Inherited From MBeanParameterInfo]

Returns the type or class name of the data.

public boolean hasDefaultValue () [Specified in OpenMBeanParameterInfo]

Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null default value for the described parameter, false otherwise.

public int hashCode () [Overrides MBeanParameterInfo] [Specified in OpenMBeanParameterInfo]

Returns the hash code value for this OpenMBeanParameterInfoSupport instance.

public boolean hasLegalValues () [Specified in OpenMBeanParameterInfo]

Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null set of legal values for the described parameter, false otherwise.

public boolean hasMaxValue () [Specified in OpenMBeanParameterInfo]

Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null maximal value for the described parameter, false otherwise.

public boolean hasMinValue () [Specified in OpenMBeanParameterInfo]

Returns true if this OpenMBeanParameterInfoSupport instance specifies a non-null minimal value for the described parameter, false otherwise.

public boolean isValue (Object obj) [Specified in OpenMBeanParameterInfo]

Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance.

Tests whether obj is a valid value for the parameter
described by this OpenMBeanParameterInfo instance.
Returns: {@code true} if {@code obj} is a valid value for the parameter described by this {@code OpenMBeanParameterInfo} instance, {@code false} otherwise.
Parameters:
- obj - the object to be tested.

public String toString () [Overrides MBeanParameterInfo] [Specified in OpenMBeanParameterInfo]

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.
Returns: a string representation of this {@code OpenMBeanParameterInfoSupport} instance.