|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
.
Method Summary | |
boolean |
equals(Object obj)
Compares the specified obj parameter with this OpenMBeanParameterInfo instance for equality.
|
Object |
getDefaultValue()
Returns the default value for this parameter, if it has one, or null otherwise. |
String |
getDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance. |
Set |
getLegalValues()
Returns the set of legal values 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. |
Comparable |
getMinValue()
Returns the minimal value for this parameter, if it has one, or null otherwise. |
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. |
boolean |
hasDefaultValue()
Returns true if this parameter has a specified default value, or false otherwise. |
int |
hashCode()
Returns the hash code value for this OpenMBeanParameterInfo instance.
|
boolean |
hasLegalValues()
Returns true if this parameter has a specified set of legal values, or false otherwise. |
boolean |
hasMaxValue()
Returns true if this parameter has a specified maximal value, or false otherwise. |
boolean |
hasMinValue()
Returns true if this parameter has a specified minimal value, or false otherwise. |
boolean |
isValue(Object obj)
Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance. |
String |
toString()
Returns a string representation of this OpenMBeanParameterInfo instance.
|
Method Detail |
public String getDescription()
public String getName()
public OpenType getOpenType()
public Object getDefaultValue()
public Set getLegalValues()
public Comparable getMinValue()
public Comparable getMaxValue()
public boolean hasDefaultValue()
public boolean hasLegalValues()
public boolean hasMinValue()
public boolean hasMaxValue()
public boolean isValue(Object obj)
OpenMBeanParameterInfo
instance.
obj
- the object to be tested.
true
if obj is a valid value
for for the parameter described by this
OpenMBeanParameterInfo
instance,
false
otherwise.public boolean equals(Object obj)
OpenMBeanParameterInfo
instance for equality.
Returns true if and only if all of the following statements are true:
OpenMBeanParameterInfo
interface,OpenMBeanParameterInfo
interface.
obj
- the object to be compared for equality with this OpenMBeanParameterInfo
instance;
true
if the specified object is equal to this OpenMBeanParameterInfo
instance.public int hashCode()
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
.
OpenMBeanParameterInfo
instancepublic String toString()
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.
OpenMBeanParameterInfo
instance
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.