OpenMBeanParameterInfo

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> management >> [ openmbean overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.management.openmbean.OpenMBeanParameterInfo

SOURCE |

Download javax.management.openmbean.OpenMBeanParameterInfo

DOWNLOAD | 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.1.2.1 $

Method Summary

boolean equals(java.lang.Object obj)
          Compares an object for equality with the implementing class.

java.lang.Object getDefaultValue()
          Retrieve the default value for this parameter or null if there is no default

java.lang.String getDescription()
          Retrieve a human readable description of the open MBean parameter the implementation of this interface describes.

java.util.Set getLegalValues()
          Retrieve the legal values values for this parameter or null if this is not specified

java.lang.Comparable getMaxValue()
          Retrieve the maximum values values for this parameter or null if this is not specified

java.lang.Comparable getMinValue()
          Retrieve the minimum values values for this parameter or null if this is not specified

java.lang.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(java.lang.Object obj)
          Tests whether an object is acceptable as a paramter value

java.lang.String toString()
          A string representation of the open mbean parameter info.

Method Detail

getDescription

public java.lang.String getDescription()

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

getName

public java.lang.String getName()

Retrieve the name of the parameter described.

getOpenType

public OpenType getOpenType()

Retrieve the open type for this parameter

getDefaultValue

public java.lang.Object getDefaultValue()

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

getLegalValues

public java.util.Set getLegalValues()

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

getMinValue

public java.lang.Comparable getMinValue()

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

getMaxValue

public java.lang.Comparable getMaxValue()

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

hasDefaultValue

public boolean hasDefaultValue()

Discover wether this parameter has a default value specified

hasLegalValues

public boolean hasLegalValues()

Discover wether this parameter has legal values specified

hasMinValue

public boolean hasMinValue()

Discover wether this parameter has a minimum value specified

hasMaxValue

public boolean hasMaxValue()

Discover wether this parameter has a maximum value specified

isValue

public boolean isValue(java.lang.Object obj)

Tests whether an object is acceptable as a paramter value

equals

public boolean equals(java.lang.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

hashCode

public int hashCode()

Generates a hashcode for the implementation.

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

toString

public java.lang.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