public interface

OpenMBeanParameterInfo

javax.management.openmbean.OpenMBeanParameterInfo
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract boolean equals(Object obj)
Compares the specified obj parameter with this OpenMBeanParameterInfo instance for equality.
abstract Object getDefaultValue()
Returns the default value for this parameter, if it has one, or null otherwise.
abstract String getDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.
abstract Set<?> getLegalValues()
Returns the set of legal values for this parameter, if it has one, or null otherwise.
abstract Comparable<?> getMaxValue()
Returns the maximal value for this parameter, if it has one, or null otherwise.
abstract Comparable<?> getMinValue()
Returns the minimal value for this parameter, if it has one, or null otherwise.
abstract String getName()
Returns the name of the parameter described by this OpenMBeanParameterInfo instance.
abstract OpenType<?> getOpenType()
Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.
abstract boolean hasDefaultValue()
Returns true if this parameter has a specified default value, or false otherwise.
abstract boolean hasLegalValues()
Returns true if this parameter has a specified set of legal values, or false otherwise.
abstract boolean hasMaxValue()
Returns true if this parameter has a specified maximal value, or false otherwise.
abstract boolean hasMinValue()
Returns true if this parameter has a specified minimal value, or false otherwise.
abstract int hashCode()
Returns the hash code value for this OpenMBeanParameterInfo instance.
abstract boolean isValue(Object obj)
Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance.
abstract String toString()
Returns a string representation of this OpenMBeanParameterInfo instance.

Public Methods

public abstract 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:

  • 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.
This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanParameterInfo interface.
 

Parameters
obj the object to be compared for equality with this OpenMBeanParameterInfo instance;
Returns
  • true if the specified object is equal to this OpenMBeanParameterInfo instance.

public abstract Object getDefaultValue ()

Returns the default value for this parameter, if it has one, or null otherwise.

Returns
  • the default value.

public abstract String getDescription ()

Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.

Returns
  • the description.

public abstract Set<?> getLegalValues ()

Returns the set of legal values for this parameter, if it has one, or null otherwise.

Returns
  • the set of legal values.

public abstract Comparable<?> getMaxValue ()

Returns the maximal value for this parameter, if it has one, or null otherwise.

Returns
  • the maximum value.

public abstract Comparable<?> getMinValue ()

Returns the minimal value for this parameter, if it has one, or null otherwise.

Returns
  • the minimum value.

public abstract String getName ()

Returns the name of the parameter described by this OpenMBeanParameterInfo instance.

Returns
  • the name.

public abstract OpenType<?> getOpenType ()

Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.

Returns
  • the open type.

public abstract boolean hasDefaultValue ()

Returns true if this parameter has a specified default value, or false otherwise.

Returns
  • true if there is a default value.

public abstract boolean hasLegalValues ()

Returns true if this parameter has a specified set of legal values, or false otherwise.

Returns
  • true if there is a set of legal values.

public abstract boolean hasMaxValue ()

Returns true if this parameter has a specified maximal value, or false otherwise.

Returns
  • true if there is a maximum value.

public abstract boolean hasMinValue ()

Returns true if this parameter has a specified minimal value, or false otherwise.

Returns
  • true if there is a minimum value.

public abstract 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().

Returns
  • the hash code value for this OpenMBeanParameterInfo instance

public abstract boolean isValue (Object obj)

Tests whether obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance.

Parameters
obj the object to be tested.
Returns
  • true if obj is a valid value for the parameter described by this OpenMBeanParameterInfo instance, false otherwise.

public abstract 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.

Returns
  • a string representation of this OpenMBeanParameterInfo instance