javax.management.openmbean
Interface OpenMBeanParameterInfo

All Known Subinterfaces:
OpenMBeanAttributeInfo
All Known Implementing Classes:
OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport

public interface OpenMBeanParameterInfo

Describes the parameters of a constructor or operation associated with an open management bean. This interface includes those methods specified by MBeanParameterInfo, so implementations should extend this class.

Since:
1.5

Method Summary
 boolean equals(Object obj)
          Compares this parameter with the supplied object.
 Object getDefaultValue()
          Returns the default value of this parameter, or null if there is no default value.
 String getDescription()
          Returns a description of this parameter.
 Set<?> getLegalValues()
          Returns a Set enumerating the legal values of this parameter, or null if no such limited set exists for this parameter.
 Comparable<?> getMaxValue()
          Returns the maximum value of this parameter, or null if there is no maximum.
 Comparable<?> getMinValue()
          Returns the minimum value of this parameter, or null if there is no minimum.
 String getName()
          Returns the name of this parameter.
 OpenType<?> getOpenType()
          Returns the open type instance which represents the type of this parameter.
 boolean hasDefaultValue()
          Returns true if this parameter has a default value.
 int hashCode()
          Returns the hashcode of the parameter information as the sum of the hashcodes of the name, open type, default value, maximum value, minimum value and the set of legal values.
 boolean hasLegalValues()
          Returns true if there is a set of legal values for this parameter.
 boolean hasMaxValue()
          Returns true if there is a maximum value for this parameter.
 boolean hasMinValue()
          Returns true if there is a minimum value for this parameter.
 boolean isValue(Object obj)
          Returns true if the specified object is a valid value for this parameter.
 String toString()
          Returns a textual representation of this instance.
 

Method Detail

equals

boolean equals(Object obj)
Compares this parameter with the supplied object. This returns true iff the object is an instance of OpenMBeanParameterInfo with an equal name and open type and the same default, minimum, maximum and legal values.

Overrides:
equals in class Object
Parameters:
obj - the object to compare.
Returns:
true if the object is a OpenMBeanParameterInfo instance, name.equals(object.getName()), openType.equals(object.getOpenType()), defaultValue.equals(object.getDefaultValue()), minValue.equals(object.getMinValue()), maxValue.equals(object.getMaxValue()), and legalValues.equals(object.getLegalValues()).
See Also:
Object.hashCode()

getDefaultValue

Object getDefaultValue()
Returns the default value of this parameter, or null if there is no default value.

Returns:
the default value of the parameter, or null if there is no default.

getDescription

String getDescription()
Returns a description of this parameter.

Returns:
a human-readable description.

getLegalValues

Set<?> getLegalValues()
Returns a Set enumerating the legal values of this parameter, or null if no such limited set exists for this parameter.

Returns:
a set of legal values, or null if no such set exists.

getMaxValue

Comparable<?> getMaxValue()
Returns the maximum value of this parameter, or null if there is no maximum.

Returns:
the maximum value, or null if none exists.

getMinValue

Comparable<?> getMinValue()
Returns the minimum value of this parameter, or null if there is no minimum.

Returns:
the minimum value, or null if none exists.

getName

String getName()
Returns the name of this parameter.

Returns:
the name of the parameter.

getOpenType

OpenType<?> getOpenType()
Returns the open type instance which represents the type of this parameter.

Returns:
the open type of this parameter.

hasDefaultValue

boolean hasDefaultValue()
Returns true if this parameter has a default value.

Returns:
true if this parameter has a default.

hashCode

int hashCode()
Returns the hashcode of the parameter information as the sum of the hashcodes of the name, open type, default value, maximum value, minimum value and the set of legal values.

Overrides:
hashCode in class Object
Returns:
the hashcode of the parameter information.
See Also:
Object.equals(Object), System.identityHashCode(Object)

hasLegalValues

boolean hasLegalValues()
Returns true if there is a set of legal values for this parameter.

Returns:
true if a set of legal values exists for this parameter.

hasMaxValue

boolean hasMaxValue()
Returns true if there is a maximum value for this parameter.

Returns:
true if a maximum value exists for this parameter.

hasMinValue

boolean hasMinValue()
Returns true if there is a minimum value for this parameter.

Returns:
true if a minimum value exists for this parameter.

isValue

boolean isValue(Object obj)
Returns true if the specified object is a valid value for this parameter.

Parameters:
obj - the object to test.
Returns:
true if obj is a valid value for this parameter.

toString

String toString()
Returns a textual representation of this instance. This is constructed using the class name (javax.management.openmbean.OpenMBeanParameterInfo) along with the name, open type, default, minimum, maximum and legal values of the parameter.

Overrides:
toString in class Object
Returns:
a @link{java.lang.String} instance representing the instance in textual form.
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)