javax.management.openmbean
Interface OpenMBeanParameterInfo

All Known Subinterfaces:
OpenMBeanAttributeInfo sample code for javax.management.openmbean.OpenMBeanAttributeInfo definition code for javax.management.openmbean.OpenMBeanAttributeInfo
All Known Implementing Classes:
OpenMBeanAttributeInfoSupport sample code for javax.management.openmbean.OpenMBeanAttributeInfoSupport definition code for javax.management.openmbean.OpenMBeanAttributeInfoSupport , OpenMBeanParameterInfoSupport sample code for javax.management.openmbean.OpenMBeanParameterInfoSupport definition code for javax.management.openmbean.OpenMBeanParameterInfoSupport

public interface OpenMBeanParameterInfo

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

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

Since:
1.5

Method Summary
 boolean equals sample code for javax.management.openmbean.OpenMBeanParameterInfo.equals(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanParameterInfo.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares the specified obj parameter with this OpenMBeanParameterInfo instance for equality.
 Object sample code for java.lang.Object definition code for java.lang.Object getDefaultValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.getDefaultValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getDefaultValue() ()
          Returns the default value for this parameter, if it has one, or null otherwise.
 String sample code for java.lang.String definition code for java.lang.String getDescription sample code for javax.management.openmbean.OpenMBeanParameterInfo.getDescription() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getDescription() ()
          Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.
 Set sample code for java.util.Set definition code for java.util.Set getLegalValues sample code for javax.management.openmbean.OpenMBeanParameterInfo.getLegalValues() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getLegalValues() ()
          Returns the set of legal values for this parameter, if it has one, or null otherwise.
 Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable getMaxValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.getMaxValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getMaxValue() ()
          Returns the maximal value for this parameter, if it has one, or null otherwise.
 Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable getMinValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.getMinValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getMinValue() ()
          Returns the minimal value for this parameter, if it has one, or null otherwise.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.management.openmbean.OpenMBeanParameterInfo.getName() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getName() ()
          Returns the name of the parameter described by this OpenMBeanParameterInfo instance.
 OpenType sample code for javax.management.openmbean.OpenType definition code for javax.management.openmbean.OpenType getOpenType sample code for javax.management.openmbean.OpenMBeanParameterInfo.getOpenType() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getOpenType() ()
          Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.
 boolean hasDefaultValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasDefaultValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasDefaultValue() ()
          Returns true if this parameter has a specified default value, or false otherwise.
 int hashCode sample code for javax.management.openmbean.OpenMBeanParameterInfo.hashCode() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hashCode() ()
          Returns the hash code value for this OpenMBeanParameterInfo instance.
 boolean hasLegalValues sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasLegalValues() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasLegalValues() ()
          Returns true if this parameter has a specified set of legal values, or false otherwise.
 boolean hasMaxValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasMaxValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasMaxValue() ()
          Returns true if this parameter has a specified maximal value, or false otherwise.
 boolean hasMinValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasMinValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasMinValue() ()
          Returns true if this parameter has a specified minimal value, or false otherwise.
 boolean isValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.isValue(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanParameterInfo.isValue(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.management.openmbean.OpenMBeanParameterInfo.toString() definition code for javax.management.openmbean.OpenMBeanParameterInfo.toString() ()
          Returns a string representation of this OpenMBeanParameterInfo instance.
 

Method Detail

getDescription sample code for javax.management.openmbean.OpenMBeanParameterInfo.getDescription() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getDescription()

String sample code for java.lang.String definition code for java.lang.String  getDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.

Returns:
the description.

getName sample code for javax.management.openmbean.OpenMBeanParameterInfo.getName() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getName()

String sample code for java.lang.String definition code for java.lang.String  getName()
Returns the name of the parameter described by this OpenMBeanParameterInfo instance.

Returns:
the name.

getOpenType sample code for javax.management.openmbean.OpenMBeanParameterInfo.getOpenType() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getOpenType()

OpenType sample code for javax.management.openmbean.OpenType definition code for javax.management.openmbean.OpenType  getOpenType()
Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.

Returns:
the open type.

getDefaultValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.getDefaultValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getDefaultValue()

Object sample code for java.lang.Object definition code for java.lang.Object  getDefaultValue()
Returns the default value for this parameter, if it has one, or null otherwise.

Returns:
the default value.

getLegalValues sample code for javax.management.openmbean.OpenMBeanParameterInfo.getLegalValues() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getLegalValues()

Set sample code for java.util.Set definition code for java.util.Set  getLegalValues()
Returns the set of legal values for this parameter, if it has one, or null otherwise.

Returns:
the set of legal values.

getMinValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.getMinValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getMinValue()

Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable  getMinValue()
Returns the minimal value for this parameter, if it has one, or null otherwise.

Returns:
the minimum value.

getMaxValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.getMaxValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.getMaxValue()

Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable  getMaxValue()
Returns the maximal value for this parameter, if it has one, or null otherwise.

Returns:
the maximum value.

hasDefaultValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasDefaultValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasDefaultValue()

boolean hasDefaultValue()
Returns true if this parameter has a specified default value, or false otherwise.

Returns:
true if there is a default value.

hasLegalValues sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasLegalValues() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasLegalValues()

boolean hasLegalValues()
Returns true if this parameter has a specified set of legal values, or false otherwise.

Returns:
true if there is a set of legal values.

hasMinValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasMinValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasMinValue()

boolean hasMinValue()
Returns true if this parameter has a specified minimal value, or false otherwise.

Returns:
true if there is a minimum value.

hasMaxValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.hasMaxValue() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hasMaxValue()

boolean hasMaxValue()
Returns true if this parameter has a specified maximal value, or false otherwise.

Returns:
true if there is a maximum value.

isValue sample code for javax.management.openmbean.OpenMBeanParameterInfo.isValue(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanParameterInfo.isValue(java.lang.Object)

boolean isValue(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance.

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

equals sample code for javax.management.openmbean.OpenMBeanParameterInfo.equals(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanParameterInfo.equals(java.lang.Object)

boolean equals(Object sample code for java.lang.Object definition code for java.lang.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:

This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanParameterInfo interface.
 

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
obj - the object to be compared for equality with this OpenMBeanParameterInfo instance;
Returns:
true if the specified object is equal to this OpenMBeanParameterInfo instance.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for javax.management.openmbean.OpenMBeanParameterInfo.hashCode() definition code for javax.management.openmbean.OpenMBeanParameterInfo.hashCode()

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() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() .

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the hash code value for this OpenMBeanParameterInfo instance
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for javax.management.openmbean.OpenMBeanParameterInfo.toString() definition code for javax.management.openmbean.OpenMBeanParameterInfo.toString()

String sample code for java.lang.String definition code for java.lang.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.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this OpenMBeanParameterInfo instance