- All Known Subinterfaces:
OpenMBeanAttributeInfo
- All Known Implementing Classes:
OpenMBeanAttributeInfoSupport
,OpenMBeanParameterInfoSupport
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
.
- Since:
- 1.5
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the specified obj parameter with thisOpenMBeanParameterInfo
instance for equality.Returns the default value for this parameter, if it has one, ornull
otherwise.Returns a human readable description of the parameter described by thisOpenMBeanParameterInfo
instance.Set
<?> Returns the set of legal values for this parameter, if it has one, ornull
otherwise.Comparable
<?> Returns the maximal value for this parameter, if it has one, ornull
otherwise.Comparable
<?> Returns the minimal value for this parameter, if it has one, ornull
otherwise.getName()
Returns the name of the parameter described by thisOpenMBeanParameterInfo
instance.OpenType
<?> Returns the open type of the values of the parameter described by thisOpenMBeanParameterInfo
instance.boolean
Returnstrue
if this parameter has a specified default value, orfalse
otherwise.int
hashCode()
Returns the hash code value for thisOpenMBeanParameterInfo
instance.boolean
Returnstrue
if this parameter has a specified set of legal values, orfalse
otherwise.boolean
Returnstrue
if this parameter has a specified maximal value, orfalse
otherwise.boolean
Returnstrue
if this parameter has a specified minimal value, orfalse
otherwise.boolean
Tests whether obj is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance.toString()
Returns a string representation of thisOpenMBeanParameterInfo
instance.
-
Method Details
-
getDescription
String getDescription()Returns a human readable description of the parameter described by thisOpenMBeanParameterInfo
instance.- Returns:
- the description.
-
getName
String getName()Returns the name of the parameter described by thisOpenMBeanParameterInfo
instance.- Returns:
- the name.
-
getOpenType
OpenType<?> getOpenType()Returns the open type of the values of the parameter described by thisOpenMBeanParameterInfo
instance.- Returns:
- the open type.
-
getDefaultValue
Object getDefaultValue()Returns the default value for this parameter, if it has one, ornull
otherwise.- Returns:
- the default value.
-
getLegalValues
Set<?> getLegalValues()Returns the set of legal values for this parameter, if it has one, ornull
otherwise.- Returns:
- the set of legal values.
-
getMinValue
Comparable<?> getMinValue()Returns the minimal value for this parameter, if it has one, ornull
otherwise.- Returns:
- the minimum value.
-
getMaxValue
Comparable<?> getMaxValue()Returns the maximal value for this parameter, if it has one, ornull
otherwise.- Returns:
- the maximum value.
-
hasDefaultValue
boolean hasDefaultValue()Returnstrue
if this parameter has a specified default value, orfalse
otherwise.- Returns:
- true if there is a default value.
-
hasLegalValues
boolean hasLegalValues()Returnstrue
if this parameter has a specified set of legal values, orfalse
otherwise.- Returns:
- true if there is a set of legal values.
-
hasMinValue
boolean hasMinValue()Returnstrue
if this parameter has a specified minimal value, orfalse
otherwise.- Returns:
- true if there is a minimum value.
-
hasMaxValue
boolean hasMaxValue()Returnstrue
if this parameter has a specified maximal value, orfalse
otherwise.- Returns:
- true if there is a maximum value.
-
isValue
Tests whether obj is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance.- Parameters:
obj
- the object to be tested.- Returns:
true
if obj is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance,false
otherwise.
-
equals
Compares the specified obj parameter with thisOpenMBeanParameterInfo
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.
equals
method works properly for obj parameters which are different implementations of theOpenMBeanParameterInfo
interface.
-
hashCode
int hashCode()Returns the hash code value for thisOpenMBeanParameterInfo
instance.The hash code of an
OpenMBeanParameterInfo
instance is the sum of the hash codes of all elements of information used inequals
comparisons (ie: its name, its open type, and its default, min, max and legal values).This ensures that
t1.equals(t2)
implies thatt1.hashCode()==t2.hashCode()
for any twoOpenMBeanParameterInfo
instancest1
andt2
, as required by the general contract of the methodObject.hashCode()
. -
toString
String toString()Returns a string representation of thisOpenMBeanParameterInfo
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.
-