Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.management.openmbean
Interface OpenMBeanParameterInfo

All Known Subinterfaces:
  OpenMBeanAttributeInfo

All Known Implementing Classes:
  OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport

public interface OpenMBeanParameterInfo

An open MBean parameter info implements this interface as well as extending MBeanParameterInfo.

`OpenMBeanParameterInfoSupport` is an example of such a class.

Version:
  $Revision: 1.3 $
Author:
  Adrian Brock.

Method Summary
`boolean` | `equals(Object obj)` Compares an object for equality with the implementing class.
`Object` | `getDefaultValue()` Retrieve the default value for this parameter or null if there is no default
`String` | `getDescription()` Retrieve a human readable description of the open MBean parameter the implementation of this interface describes.
`Set` | `getLegalValues()` Retrieve the legal values values for this parameter or null if this is not specified
`Comparable` | `getMaxValue()` Retrieve the maximum values values for this parameter or null if this is not specified
`Comparable` | `getMinValue()` Retrieve the minimum values values for this parameter or null if this is not specified
`String` | `getName()` Retrieve the name of the parameter described.
`OpenType` | `getOpenType()` Retrieve the open type for this parameter
`boolean` | `hasDefaultValue()` Discover wether this parameter has a default value specified
`int` | `hashCode()` Generates a hashcode for the implementation.
`boolean` | `hasLegalValues()` Discover wether this parameter has legal values specified
`boolean` | `hasMaxValue()` Discover wether this parameter has a maximum value specified
`boolean` | `hasMinValue()` Discover wether this parameter has a minimum value specified
`boolean` | `isValue(Object obj)` Tests whether an object is acceptable as a paramter value
`String` | `toString()` A string representation of the open mbean parameter info.

Method Detail

### getDescription

    public String getDescription()

  Retrieve a human readable description of the open MBean parameter the implementation of this interface describes.

  Returns:
    the description.

### getName

    public String getName()

  Retrieve the name of the parameter described.

  Returns:
    the name.

### getOpenType

    public OpenType getOpenType()

  Retrieve the open type for this parameter

  Returns:
    the open type.

### getDefaultValue

    public Object getDefaultValue()

  Retrieve the default value for this parameter or null if there is no default

  Returns:
    the default value

### getLegalValues

    public Set getLegalValues()

  Retrieve the legal values values for this parameter or null if this is not specified

  Returns:
    the legal value

### getMinValue

    public Comparable getMinValue()

  Retrieve the minimum values values for this parameter or null if this is not specified

  Returns:
    the minimum value

### getMaxValue

    public Comparable getMaxValue()

  Retrieve the maximum values values for this parameter or null if this is not specified

  Returns:
    the maximum value

### hasDefaultValue

    public boolean hasDefaultValue()

  Discover wether this parameter has a default value specified

  Returns:
    true when a default value is specified or false otherwise

### hasLegalValues

    public boolean hasLegalValues()

  Discover wether this parameter has legal values specified

  Returns:
    true when the legal values are specified or false otherwise

### hasMinValue

    public boolean hasMinValue()

  Discover wether this parameter has a minimum value specified

  Returns:
    true when a minimum value is specified or false otherwise

### hasMaxValue

    public boolean hasMaxValue()

  Discover wether this parameter has a maximum value specified

  Returns:
    true when a maximum value is specified or false otherwise

### isValue

    public boolean isValue(Object obj)

  Tests whether an object is acceptable as a paramter value

  Parameters:
    `obj` - the object to test
  Returns:
    true when it is a valid value, or false otherwise

### equals

    public boolean equals(Object obj)

  Compares an object for equality with the implementing class.

  The object is not null
  The object implements the open mbean attribute info interface
  The parameter names are equal
  The open types are equal
  The default, min, max and legal values are equal

  Parameters:
    `obj` - the object to test
  Returns:
    true when above is true, false otherwise

### hashCode

    public int hashCode()

  Generates a hashcode for the implementation.

  The sum of the hashCodes for the elements mentioned in the equals method

  Returns:
    the calculated hashcode

### toString

    public String toString()

  A string representation of the open mbean parameter info.

  It is made up of implementation class and the values mentioned in the equals method

  Returns:
    the string

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.