-
- All Known Subinterfaces:
OpenMBeanAttributeInfo
- All Known Implementing Classes:
OpenMBeanAttributeInfoSupport,OpenMBeanParameterInfoSupport
public interface OpenMBeanParameterInfoDescribes 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 (typicallyOpenMBeanParameterInfoSupport) should extendMBeanParameterInfo.- Since:
- 1.5
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanequals(Object obj)Compares the specified obj parameter with thisOpenMBeanParameterInfoinstance for equality.ObjectgetDefaultValue()Returns the default value for this parameter, if it has one, ornullotherwise.StringgetDescription()Returns a human readable description of the parameter described by thisOpenMBeanParameterInfoinstance.Set<?>getLegalValues()Returns the set of legal values for this parameter, if it has one, ornullotherwise.Comparable<?>getMaxValue()Returns the maximal value for this parameter, if it has one, ornullotherwise.Comparable<?>getMinValue()Returns the minimal value for this parameter, if it has one, ornullotherwise.StringgetName()Returns the name of the parameter described by thisOpenMBeanParameterInfoinstance.OpenType<?>getOpenType()Returns the open type of the values of the parameter described by thisOpenMBeanParameterInfoinstance.booleanhasDefaultValue()Returnstrueif this parameter has a specified default value, orfalseotherwise.inthashCode()Returns the hash code value for thisOpenMBeanParameterInfoinstance.booleanhasLegalValues()Returnstrueif this parameter has a specified set of legal values, orfalseotherwise.booleanhasMaxValue()Returnstrueif this parameter has a specified maximal value, orfalseotherwise.booleanhasMinValue()Returnstrueif this parameter has a specified minimal value, orfalseotherwise.booleanisValue(Object obj)Tests whether obj is a valid value for the parameter described by thisOpenMBeanParameterInfoinstance.StringtoString()Returns a string representation of thisOpenMBeanParameterInfoinstance.
-
-
-
Method Detail
-
getDescription
String getDescription()
Returns a human readable description of the parameter described by thisOpenMBeanParameterInfoinstance.- Returns:
- the description.
-
getName
String getName()
Returns the name of the parameter described by thisOpenMBeanParameterInfoinstance.- Returns:
- the name.
-
getOpenType
OpenType<?> getOpenType()
Returns the open type of the values of the parameter described by thisOpenMBeanParameterInfoinstance.- Returns:
- the open type.
-
getDefaultValue
Object getDefaultValue()
Returns the default value for this parameter, if it has one, ornullotherwise.- Returns:
- the default value.
-
getLegalValues
Set<?> getLegalValues()
Returns the set of legal values for this parameter, if it has one, ornullotherwise.- Returns:
- the set of legal values.
-
getMinValue
Comparable<?> getMinValue()
Returns the minimal value for this parameter, if it has one, ornullotherwise.- Returns:
- the minimum value.
-
getMaxValue
Comparable<?> getMaxValue()
Returns the maximal value for this parameter, if it has one, ornullotherwise.- Returns:
- the maximum value.
-
hasDefaultValue
boolean hasDefaultValue()
Returnstrueif this parameter has a specified default value, orfalseotherwise.- Returns:
- true if there is a default value.
-
hasLegalValues
boolean hasLegalValues()
Returnstrueif this parameter has a specified set of legal values, orfalseotherwise.- Returns:
- true if there is a set of legal values.
-
hasMinValue
boolean hasMinValue()
Returnstrueif this parameter has a specified minimal value, orfalseotherwise.- Returns:
- true if there is a minimum value.
-
hasMaxValue
boolean hasMaxValue()
Returnstrueif this parameter has a specified maximal value, orfalseotherwise.- Returns:
- true if there is a maximum value.
-
isValue
boolean isValue(Object obj)
Tests whether obj is a valid value for the parameter described by thisOpenMBeanParameterInfoinstance.- Parameters:
obj- the object to be tested.- Returns:
trueif obj is a valid value for the parameter described by thisOpenMBeanParameterInfoinstance,falseotherwise.
-
equals
boolean equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanParameterInfoinstance for equality.Returns
trueif and only if all of the following statements are true:- obj is non null,
- obj also implements the
OpenMBeanParameterInfointerface, - their names are equal
- their open types are equal
- their default, min, max and legal values are equal.
equalsmethod works properly for obj parameters which are different implementations of theOpenMBeanParameterInfointerface.
- Overrides:
equalsin classObject- Parameters:
obj- the object to be compared for equality with thisOpenMBeanParameterInfoinstance;- Returns:
trueif the specified object is equal to thisOpenMBeanParameterInfoinstance.- See Also:
Object.hashCode(),HashMap
-
hashCode
int hashCode()
Returns the hash code value for thisOpenMBeanParameterInfoinstance.The hash code of an
OpenMBeanParameterInfoinstance is the sum of the hash codes of all elements of information used inequalscomparisons (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 twoOpenMBeanParameterInfoinstancest1andt2, as required by the general contract of the methodObject.hashCode().- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
OpenMBeanParameterInfoinstance - See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
toString
String toString()
Returns a string representation of thisOpenMBeanParameterInfoinstance.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.
-
-