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
. A class implementing this interface (typically OpenMBeanParameterInfoSupport
) should extend MBeanParameterInfo
.
String getDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo
instance.
String getName()
Returns the name of the parameter described by this OpenMBeanParameterInfo
instance.
OpenType<?> getOpenType()
Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo
instance.
Object getDefaultValue()
Returns the default value for this parameter, if it has one, or null
otherwise.
Set<?> getLegalValues()
Returns the set of legal values for this parameter, if it has one, or null
otherwise.
Comparable<?> getMinValue()
Returns the minimal value for this parameter, if it has one, or null
otherwise.
Comparable<?> getMaxValue()
Returns the maximal value for this parameter, if it has one, or null
otherwise.
boolean hasDefaultValue()
Returns true
if this parameter has a specified default value, or false
otherwise.
boolean hasLegalValues()
Returns true
if this parameter has a specified set of legal values, or false
otherwise.
boolean hasMinValue()
Returns true
if this parameter has a specified minimal value, or false
otherwise.
boolean hasMaxValue()
Returns true
if this parameter has a specified maximal value, or false
otherwise.
boolean isValue(Object obj)
Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo
instance.
obj
- the object to be tested.true
if obj is a valid value for the parameter described by this OpenMBeanParameterInfo
instance, false
otherwise.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:
OpenMBeanParameterInfo
interface,equals
method works properly for obj parameters which are different implementations of the OpenMBeanParameterInfo
interface. equals
in class Object
obj
- the object to be compared for equality with this OpenMBeanParameterInfo
instance;true
if the specified object is equal to this OpenMBeanParameterInfo
instance.Object.hashCode()
, HashMap
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()
.
hashCode
in class Object
OpenMBeanParameterInfo
instanceObject.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
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.
toString
in class Object
OpenMBeanParameterInfo
instance
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.