javax.management
Class MBeanParameterInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--javax.management.MBeanParameterInfo

Direct Known Subclasses:

OpenMBeanParameterInfo

public class MBeanParameterInfo

extends MBeanFeatureInfo

implements java.io.Serializable, java.lang.Cloneable

The MBeanParameterInfo object describes an argument of an operation exposed by a MBean. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.

See Also:

Serialized Form

Field Summary

(package private) static MBeanParameterInfo[]

NO_PARAMS

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

Constructor Summary

MBeanParameterInfo(java.lang.String name, java.lang.String type, java.lang.String description)
Constructs a MBeanParameterInfo object.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj) Compare this MBeanParameterInfo to another.
java.lang.String	getType() Returns the type or class name of the data.
int	hashCode() Returns the hash code value for this instance.
java.lang.String	toString() Returns a human readable version of the MBeanParameterInfo instance

Methods inherited from class javax.management.MBeanFeatureInfo

getDescription, getName

Methods inherited from class java.lang.Object

, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_PARAMS

static final MBeanParameterInfo[] NO_PARAMS

Constructor Detail

MBeanParameterInfo

public MBeanParameterInfo(java.lang.String name,
                          java.lang.String type,
                          java.lang.String description)
                   throws java.lang.IllegalArgumentException

Constructs a MBeanParameterInfo object.

Parameters:

name - The name of the data

type - The type or class name of the data

description - A human readable description of the data. Optional.

Throws:

java.lang.IllegalArgumentException - if name is not a valid Java identifier or if type is not a syntactically legal Java type name. Java reserved words are not considered illegal here.

Method Detail

getType

public java.lang.String getType()

Returns the type or class name of the data.

Returns:

the type string.

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

A duplicate copy of this object is returned

equals

public boolean equals(java.lang.Object obj)

Compare this MBeanParameterInfo to another.

Overrides:

equals in class MBeanFeatureInfo

Parameters:

o - the object to compare to.

Returns:

true iff o is an MBeanParameterInfo such that its MBeanFeatureInfo.getName(), getType(), and MBeanFeatureInfo.getDescription() values are equal (not necessarily identical) to those of this MBeanParameterInfo.

hashCode

public int hashCode()

Returns the hash code value for this instance.

Overrides:

hashCode in class MBeanFeatureInfo

Returns:

hashCode for this instance

toString

public java.lang.String toString()

Returns a human readable version of the MBeanParameterInfo instance

Overrides:

toString in class MBeanFeatureInfo

Returns:

human readable version of the MBeanParameterInfo instance is returned