javax.management.openmbean: public interface: OpenMBeanParameterInfo

javax.management.openmbean
public interface: OpenMBeanParameterInfo [javadoc | source]

All Known Implementing Classes:
OpenMBeanParameterInfoSupport, OpenMBeanAttributeInfo, OpenMBeanAttributeInfoSupport

Describes a parameter used in one or more operations or constructors of an open MBean.

This interface declares the same methods as the class javax.management.MBeanParameterInfo . A class implementing this interface (typically OpenMBeanParameterInfoSupport ) should extend javax.management.MBeanParameterInfo .

since: 1.5 -

Method from javax.management.openmbean.OpenMBeanParameterInfo Summary:
equals, getDefaultValue, getDescription, getLegalValues, getMaxValue, getMinValue, getName, getOpenType, hasDefaultValue, hasLegalValues, hasMaxValue, hasMinValue, hashCode, isValue, toString

Method from javax.management.openmbean.OpenMBeanParameterInfo Detail:
public boolean equals(Object obj) Compares the specified `obj` parameter with this `OpenMBeanParameterInfo` 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.
public Object getDefaultValue() Returns the default value for this parameter, if it has one, or `null` otherwise.
public String getDescription() Returns a human readable description of the parameter described by this `OpenMBeanParameterInfo` instance.
public Set<?> getLegalValues() Returns the set of legal values for this parameter, if it has one, or `null` otherwise.
public Comparable<?> getMaxValue() Returns the maximal value for this parameter, if it has one, or `null` otherwise.
public Comparable<?> getMinValue() Returns the minimal value for this parameter, if it has one, or `null` otherwise.
public String getName() Returns the name of the parameter described by this `OpenMBeanParameterInfo` instance.
public OpenType<?> getOpenType() Returns the open type of the values of the parameter described by this `OpenMBeanParameterInfo` instance.
public boolean hasDefaultValue() Returns `true` if this parameter has a specified default value, or `false` otherwise.
public boolean hasLegalValues() Returns `true` if this parameter has a specified set of legal values, or `false` otherwise.
public boolean hasMaxValue() Returns `true` if this parameter has a specified maximal value, or `false` otherwise.
public boolean hasMinValue() Returns `true` if this parameter has a specified minimal value, or `false` otherwise.
public int hashCode() Returns the hash code value for this `OpenMBeanParameterInfo` instance. The hash code of an `OpenMBeanParameterInfo` instance is the sum of the hash codes of all elements of information used in `equals` comparisons (ie: its name, its open type, and its default, min, max and legal values). This ensures that `t1.equals(t2)` implies that `t1.hashCode()==t2.hashCode()` for any two `OpenMBeanParameterInfo` instances `t1` and `t2`, as required by the general contract of the method Object.hashCode() .
public boolean isValue(Object obj) Tests whether `obj` is a valid value for the parameter described by this `OpenMBeanParameterInfo` instance.
public String toString() Returns a string representation of this `OpenMBeanParameterInfo` instance. The string representation consists of the name of this class (ie `javax.management.openmbean.OpenMBeanParameterInfo`), the string representation of the name and open type of the described parameter, and the string representation of its default, min, max and legal values.