APIdia Launch Partner
Top Description Fields Constructors Methods
javax.management

public Class MBeanParameterInfo

extends MBeanFeatureInfo
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Known Direct Subclasses
javax.management.openmbean.OpenMBeanParameterInfoSupport
Imports
java.util.Objects
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

Field Summary

Modifier and TypeField and Description
pack-priv static final MBeanParameterInfo[]
NO_PARAMS

pack-priv static final long
serialVersionUID

Hides javax.management.MBeanFeatureInfo.serialVersionUID.

private final String
type

Inherited from javax.management.MBeanFeatureInfo:
descriptionname

Constructor Summary

AccessConstructor and Description
public
MBeanParameterInfo(String
The name of the data
name, String
The type or class name of the data
type, String
A human readable description of the data. Optional.
description)

Constructs an MBeanParameterInfo object.

public
MBeanParameterInfo(String
The name of the data
name, String
The type or class name of the data
type, String
A human readable description of the data. Optional.
description, Descriptor
The descriptor for the operation. This may be null which is equivalent to an empty descriptor.
descriptor)

Constructs an MBeanParameterInfo object.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Returns a shallow clone of this instance.

public boolean

Returns:

true if and only if o is an MBeanParameterInfo such that its getName(), getType(), getDescriptor(), and getDescription() values are equal (not necessarily identical) to those of this MBeanParameterInfo.
equals(Object
the object to compare to.
o)

Overrides javax.management.MBeanFeatureInfo.equals.

Compare this MBeanParameterInfo to another.

public String

Returns:

the type string.
getType()

Returns the type or class name of the data.

public int
hashCode()

Overrides javax.management.MBeanFeatureInfo.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from javax.management.MBeanFeatureInfo:
getDescriptiongetDescriptorgetName

Field Detail

NO_PARAMSback to summary
pack-priv static final MBeanParameterInfo[] NO_PARAMS
serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides javax.management.MBeanFeatureInfo.serialVersionUID.

typeback to summary
private final String type

Constructor Detail

MBeanParameterInfoback to summary
public MBeanParameterInfo(String name, String type, String description)

Constructs an MBeanParameterInfo object.

Parameters
name:String

The name of the data

type:String

The type or class name of the data

description:String

A human readable description of the data. Optional.

MBeanParameterInfoback to summary
public MBeanParameterInfo(String name, String type, String description, Descriptor descriptor)

Constructs an MBeanParameterInfo object.

Parameters
name:String

The name of the data

type:String

The type or class name of the data

description:String

A human readable description of the data. Optional.

descriptor:Descriptor

The descriptor for the operation. This may be null which is equivalent to an empty descriptor.

Since
1.6

Method Detail

cloneback to summary
public Object clone()

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

equalsback to summary
public boolean equals(Object o)

Overrides javax.management.MBeanFeatureInfo.equals.

Compare this MBeanParameterInfo to another.

Parameters
o:Object

the object to compare to.

Returns:boolean

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

getTypeback to summary
public String getType()

Returns the type or class name of the data.

Returns:String

the type string.

hashCodeback to summary
public int hashCode()

Overrides javax.management.MBeanFeatureInfo.hashCode.

Doc from java.lang.Object.hashCode.

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

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 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 equals 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 hash tables.
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.