MBeanParameterInfo (Java 2 Platform SE 5.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Standard Ed. 5.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management
Class MBeanParameterInfo

java.lang.Object
 extended by javax.management.MBeanFeatureInfo
 extended by javax.management.MBeanParameterInfo

All Implemented Interfaces:: Serializable, Cloneable

Direct Known Subclasses:: OpenMBeanParameterInfoSupport

public class MBeanParameterInfo
extends MBeanFeatureInfo
implements Serializable, Cloneable
extends MBeanFeatureInfo
implements Serializable, Cloneable

Describes an argument of an operation exposed by an MBean. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.

Since:: 1.5
See Also:: Serialized Form

Field Summary

Fields inherited from class javax.management.MBeanFeatureInfo
`description, name`

Constructor Summary
`MBeanParameterInfo(String name, String type, String description)` Constructs a `MBeanParameterInfo` object.

Method Summary
`Object`	`clone()` Returns a shallow clone of this instance.
`boolean`	`equals(Object o)` Compare this MBeanParameterInfo to another.
`String`	`getType()` Returns the type or class name of the data.
`int`	`hashCode()` Returns a hash code value for the object.

Methods inherited from class javax.management.MBeanFeatureInfo
`getDescription, getName`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

MBeanParameterInfo

public MBeanParameterInfo(String name,
 String type,
 String description)
 throws 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:: IllegalArgumentException

Method Detail

clone

public Object clone()

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, cloning is chiefly of interest to subclasses.

Overrides:: clone in class Object

Returns:: a clone of this instance.
See Also:: Cloneable

getType

public String getType()

Returns the type or class name of the data.

Returns:: the type string.

equals

public boolean equals(Object o)

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.
See Also:: Object.hashCode(), Hashtable

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:: hashCode in class MBeanFeatureInfo

Returns:: a hash code value for this object.
See Also:: Object.equals(java.lang.Object), Hashtable