FileDocCategorySizeDatePackage
OpenMBeanParameterInfo.javaAPI DocJava SE 5 API6414Fri Aug 26 14:57:36 BST 2005javax.management.openmbean

OpenMBeanParameterInfo

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 {@link javax.management.MBeanParameterInfo}. A class implementing this interface (typically {@link OpenMBeanParameterInfoSupport}) should extend {@link javax.management.MBeanParameterInfo}.

version
3.21 03/12/19
author
Sun Microsystems, Inc.
since
1.5
since.unbundled
JMX 1.1

Fields Summary
Constructors Summary
Methods Summary
public booleanequals(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:

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

param
obj the object to be compared for equality with this OpenMBeanParameterInfo instance;
return
true if the specified object is equal to this OpenMBeanParameterInfo instance.

public java.lang.ObjectgetDefaultValue()
Returns the default value for this parameter, if it has one, or null otherwise.

return
the default value.

public java.lang.StringgetDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.

return
the description.

public java.util.SetgetLegalValues()
Returns the set of legal values for this parameter, if it has one, or null otherwise.

return
the set of legal values.

public java.lang.ComparablegetMaxValue()
Returns the maximal value for this parameter, if it has one, or null otherwise.

return
the maximum value.

public java.lang.ComparablegetMinValue()
Returns the minimal value for this parameter, if it has one, or null otherwise.

return
the minimum value.

public java.lang.StringgetName()
Returns the name of the parameter described by this OpenMBeanParameterInfo instance.

return
the name.

public javax.management.openmbean.OpenTypegetOpenType()
Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.

return
the open type.

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

return
true if there is a default value.

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

return
true if there is a set of legal values.

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

return
true if there is a maximum value.

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

return
true if there is a minimum value.

public inthashCode()
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 {@link Object#hashCode() Object.hashCode()}.

return
the hash code value for this OpenMBeanParameterInfo instance

public booleanisValue(java.lang.Object obj)
Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance.

param
obj the object to be tested.
return
true if obj is a valid value for for the parameter described by this OpenMBeanParameterInfo instance, false otherwise.

public java.lang.StringtoString()
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.

return
a string representation of this OpenMBeanParameterInfo instance