JavaTM 2 Platform
Ent. Ed. v1.4

javax.management
Class MBeanParameterInfo

java.lang.Object
  extended byjavax.management.MBeanFeatureInfo
      extended byjavax.management.MBeanParameterInfo
All Implemented Interfaces:
Cloneable, Serializable
Direct Known Subclasses:
OpenMBeanParameterInfoSupport

public class MBeanParameterInfo
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.

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()
           
 
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 - 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

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.


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.

hashCode

public int hashCode()
Overrides:
hashCode in class MBeanFeatureInfo

JavaTM 2 Platform
Ent. Ed. v1.4

Submit a bug or feature

Copyright 2003 Sun Microsystems, Inc. All rights reserved.