APIdia Launch Partner
Top Description Methods
javax.management.openmbean

public Interface OpenMBeanParameterInfo

Known Direct Subinterfaces
javax.management.openmbean.OpenMBeanAttributeInfo
Known Direct Implementers
javax.management.openmbean.OpenMBeanParameterInfoSupport
Imports
java.util.Set, java.lang.Comparable

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 Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the specified object is equal to this OpenMBeanParameterInfo instance.
equals(Object
the object to be compared for equality with this OpenMBeanParameterInfo instance;
obj)

Compares the specified obj parameter with this OpenMBeanParameterInfo instance for equality.

public Object

Returns:

the default value.
getDefaultValue()

Returns the default value for this parameter, if it has one, or null otherwise.

public String

Returns:

the description.
getDescription()

Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.

public Set<?>

Returns:

the set of legal values.
getLegalValues()

Returns the set of legal values for this parameter, if it has one, or null otherwise.

public Comparable<?>

Returns:

the maximum value.
getMaxValue()

Returns the maximal value for this parameter, if it has one, or null otherwise.

public Comparable<?>

Returns:

the minimum value.
getMinValue()

Returns the minimal value for this parameter, if it has one, or null otherwise.

public String

Returns:

the name.
getName()

Returns the name of the parameter described by this OpenMBeanParameterInfo instance.

public OpenType<?>

Returns:

the open type.
getOpenType()

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

public boolean

Returns:

true if there is a default value.
hasDefaultValue()

Returns true if this parameter has a specified default value, or false otherwise.

public int

Returns:

the hash code value for this OpenMBeanParameterInfo instance
hashCode()

Returns the hash code value for this OpenMBeanParameterInfo instance.

public boolean

Returns:

true if there is a set of legal values.
hasLegalValues()

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

public boolean

Returns:

true if there is a maximum value.
hasMaxValue()

Returns true if this parameter has a specified maximal value, or false otherwise.

public boolean

Returns:

true if there is a minimum value.
hasMinValue()

Returns true if this parameter has a specified minimal value, or false otherwise.

public boolean

Returns:

true if obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance, false otherwise.
isValue(Object
the object to be tested.
obj)

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

public String

Returns:

a string representation of this OpenMBeanParameterInfo instance
toString()

Returns a string representation of this OpenMBeanParameterInfo instance.

Method Detail

equalsback to summary
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.
 
Parameters
obj:Object

the object to be compared for equality with this OpenMBeanParameterInfo instance;

Returns:boolean

true if the specified object is equal to this OpenMBeanParameterInfo instance.

getDefaultValueback to summary
public Object getDefaultValue()

Returns the default value for this parameter, if it has one, or null otherwise.

Returns:Object

the default value.

getDescriptionback to summary
public String getDescription()

Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.

Returns:String

the description.

getLegalValuesback to summary
public Set<?> getLegalValues()

Returns the set of legal values for this parameter, if it has one, or null otherwise.

Returns:Set<?>

the set of legal values.

getMaxValueback to summary
public Comparable<?> getMaxValue()

Returns the maximal value for this parameter, if it has one, or null otherwise.

Returns:Comparable<?>

the maximum value.

getMinValueback to summary
public Comparable<?> getMinValue()

Returns the minimal value for this parameter, if it has one, or null otherwise.

Returns:Comparable<?>

the minimum value.

getNameback to summary
public String getName()

Returns the name of the parameter described by this OpenMBeanParameterInfo instance.

Returns:String

the name.

getOpenTypeback to summary
public OpenType<?> getOpenType()

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

Returns:OpenType<?>

the open type.

hasDefaultValueback to summary
public boolean hasDefaultValue()

Returns true if this parameter has a specified default value, or false otherwise.

Returns:boolean

true if there is a default value.

hashCodeback to summary
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().

Returns:int

the hash code value for this OpenMBeanParameterInfo instance

hasLegalValuesback to summary
public boolean hasLegalValues()

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

Returns:boolean

true if there is a set of legal values.

hasMaxValueback to summary
public boolean hasMaxValue()

Returns true if this parameter has a specified maximal value, or false otherwise.

Returns:boolean

true if there is a maximum value.

hasMinValueback to summary
public boolean hasMinValue()

Returns true if this parameter has a specified minimal value, or false otherwise.

Returns:boolean

true if there is a minimum value.

isValueback to summary
public boolean isValue(Object obj)

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

Parameters
obj:Object

the object to be tested.

Returns:boolean

true if obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance, false otherwise.

toStringback to summary
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.

Returns:String

a string representation of this OpenMBeanParameterInfo instance