APIdia Launch Partner
Top Description Fields Constructors Methods
javax.management.openmbean

public Class OpenMBeanOperationInfoSupport

extends MBeanOperationInfo
implements OpenMBeanOperationInfo
Class Inheritance
All Implemented Interfaces
javax.management.openmbean.OpenMBeanOperationInfo
Imports
java.util.Arrays, javax.management.Descriptor, .ImmutableDescriptor, .MBeanOperationInfo, .MBeanParameterInfo
Describes an operation of an Open MBean.
Since
1.5

Field Summary

Modifier and TypeField and Description
private transient Integer
myHashCode

private transient String
myToString

private OpenType<?>
returnOpenType

pack-priv static final long
serialVersionUID

Hides javax.management.MBeanOperationInfo.serialVersionUID.

Inherited from javax.management.MBeanOperationInfo:
ACTIONACTION_INFOINFOUNKNOWN

Constructor Summary

AccessConstructor and Description
public
OpenMBeanOperationInfoSupport(String
cannot be a null or empty string.
name, String
cannot be a null or empty string.
description, OpenMBeanParameterInfo[]
can be null or empty if there are no parameters to describe.
signature, OpenType<?>
cannot be null: use SimpleType.VOID for operations that return nothing.
returnOpenType, int
must be one of ACTION, ACTION_INFO, INFO, or UNKNOWN.
impact)

Constructs an OpenMBeanOperationInfoSupport instance, which describes the operation of a class of open MBeans, with the specified name, description, signature, returnOpenType and impact.

public
OpenMBeanOperationInfoSupport(String
cannot be a null or empty string.
name, String
cannot be a null or empty string.
description, OpenMBeanParameterInfo[]
can be null or empty if there are no parameters to describe.
signature, OpenType<?>
cannot be null: use SimpleType.VOID for operations that return nothing.
returnOpenType, int
must be one of ACTION, ACTION_INFO, INFO, or UNKNOWN.
impact, Descriptor
The descriptor for the operation. This may be null, which is equivalent to an empty descriptor.
descriptor)

Constructs an OpenMBeanOperationInfoSupport instance, which describes the operation of a class of open MBeans, with the specified name, description, signature, returnOpenType, impact, and descriptor.

Method Summary

Modifier and TypeMethod and Description
private static MBeanParameterInfo[]
arrayCopyCast(OpenMBeanParameterInfo[] src)

private static OpenMBeanParameterInfo[]
arrayCopyCast(MBeanParameterInfo[] src)

public boolean

Returns:

true if the specified object is equal to this OpenMBeanOperationInfoSupport instance.
equals(Object
the object to be compared for equality with this OpenMBeanOperationInfoSupport instance;
obj)

Overrides javax.management.MBeanOperationInfo.equals.

Implements javax.management.openmbean.OpenMBeanOperationInfo.equals.

Compares the specified obj parameter with this OpenMBeanOperationInfoSupport instance for equality.

public OpenType<?>
getReturnOpenType()

Implements javax.management.openmbean.OpenMBeanOperationInfo.getReturnOpenType.

Returns the open type of the values returned by the operation described by this OpenMBeanOperationInfo instance.

public int

Returns:

the hash code value for this OpenMBeanOperationInfoSupport instance
hashCode()

Overrides javax.management.MBeanOperationInfo.hashCode.

Implements javax.management.openmbean.OpenMBeanOperationInfo.hashCode.

Returns the hash code value for this OpenMBeanOperationInfoSupport instance.

private Object
readResolve()

An object serialized in a version of the API before Descriptors were added to this class will have an empty or null Descriptor.

public String

Returns:

a string representation of this OpenMBeanOperationInfoSupport instance
toString()

Overrides javax.management.MBeanOperationInfo.toString.

Implements javax.management.openmbean.OpenMBeanOperationInfo.toString.

Returns a string representation of this OpenMBeanOperationInfoSupport instance.

Inherited from javax.management.MBeanOperationInfo:
clonegetImpactgetReturnTypegetSignature

Field Detail

myHashCodeback to summary
private transient Integer myHashCode
myToStringback to summary
private transient String myToString
returnOpenTypeback to summary
private OpenType<?> returnOpenType
serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides javax.management.MBeanOperationInfo.serialVersionUID.

Constructor Detail

OpenMBeanOperationInfoSupportback to summary
public OpenMBeanOperationInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, OpenType<?> returnOpenType, int impact)

Constructs an OpenMBeanOperationInfoSupport instance, which describes the operation of a class of open MBeans, with the specified name, description, signature, returnOpenType and impact.

The signature array parameter is internally copied, so that subsequent changes to the array referenced by signature have no effect on this instance.

Parameters
name:String

cannot be a null or empty string.

description:String

cannot be a null or empty string.

signature:OpenMBeanParameterInfo[]

can be null or empty if there are no parameters to describe.

returnOpenType:OpenType<?>

cannot be null: use SimpleType.VOID for operations that return nothing.

impact:int

must be one of ACTION, ACTION_INFO, INFO, or UNKNOWN.

Exceptions
IllegalArgumentException:
if name or description are null or empty string, or returnOpenType is null, or impact is not one of ACTION, ACTION_INFO, INFO, or UNKNOWN.
ArrayStoreException:
If signature is not an array of instances of a subclass of MBeanParameterInfo.
OpenMBeanOperationInfoSupportback to summary
public OpenMBeanOperationInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, OpenType<?> returnOpenType, int impact, Descriptor descriptor)

Constructs an OpenMBeanOperationInfoSupport instance, which describes the operation of a class of open MBeans, with the specified name, description, signature, returnOpenType, impact, and descriptor.

The signature array parameter is internally copied, so that subsequent changes to the array referenced by signature have no effect on this instance.

Parameters
name:String

cannot be a null or empty string.

description:String

cannot be a null or empty string.

signature:OpenMBeanParameterInfo[]

can be null or empty if there are no parameters to describe.

returnOpenType:OpenType<?>

cannot be null: use SimpleType.VOID for operations that return nothing.

impact:int

must be one of ACTION, ACTION_INFO, INFO, or UNKNOWN.

descriptor:Descriptor

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

Exceptions
IllegalArgumentException:
if name or description are null or empty string, or returnOpenType is null, or impact is not one of ACTION, ACTION_INFO, INFO, or UNKNOWN.
ArrayStoreException:
If signature is not an array of instances of a subclass of MBeanParameterInfo.
Since
1.6

Method Detail

arrayCopyCastback to summary
private static MBeanParameterInfo[] arrayCopyCast(OpenMBeanParameterInfo[] src)
arrayCopyCastback to summary
private static OpenMBeanParameterInfo[] arrayCopyCast(MBeanParameterInfo[] src)
equalsback to summary
public boolean equals(Object obj)

Overrides javax.management.MBeanOperationInfo.equals.

Implements javax.management.openmbean.OpenMBeanOperationInfo.equals.

Compares the specified obj parameter with this OpenMBeanOperationInfoSupport instance for equality.

Returns true if and only if all of the following statements are true:

  • obj is non null,
  • obj also implements the OpenMBeanOperationInfo interface,
  • their names are equal
  • their signatures are equal
  • their return open types are equal
  • their impacts are equal
This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanOperationInfo interface.
Parameters
obj:Object

the object to be compared for equality with this OpenMBeanOperationInfoSupport instance;

Returns:boolean

true if the specified object is equal to this OpenMBeanOperationInfoSupport instance.

getReturnOpenTypeback to summary
public OpenType<?> getReturnOpenType()

Implements javax.management.openmbean.OpenMBeanOperationInfo.getReturnOpenType.

Returns the open type of the values returned by the operation described by this OpenMBeanOperationInfo instance.

hashCodeback to summary
public int hashCode()

Overrides javax.management.MBeanOperationInfo.hashCode.

Implements javax.management.openmbean.OpenMBeanOperationInfo.hashCode.

Returns the hash code value for this OpenMBeanOperationInfoSupport instance.

The hash code of an OpenMBeanOperationInfoSupport instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to java.util.Arrays.asList(this.getSignature).hashCode()).

This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two OpenMBeanOperationInfoSupport instances t1 and t2, as required by the general contract of the method Object.hashCode().

However, note that another instance of a class implementing the OpenMBeanOperationInfo interface may be equal to this OpenMBeanOperationInfoSupport instance as defined by equals(java.lang.Object), but may have a different hash code if it is calculated differently.

As OpenMBeanOperationInfoSupport instances are immutable, the hash code for this instance is calculated once, on the first call to hashCode, and then the same value is returned for subsequent calls.

Returns:int

the hash code value for this OpenMBeanOperationInfoSupport instance

readResolveback to summary
private Object readResolve()

An object serialized in a version of the API before Descriptors were added to this class will have an empty or null Descriptor. For consistency with our behavior in this version, we must replace the object with one where the Descriptors reflect the same value of returned openType.

toStringback to summary
public String toString()

Overrides javax.management.MBeanOperationInfo.toString.

Implements javax.management.openmbean.OpenMBeanOperationInfo.toString.

Returns a string representation of this OpenMBeanOperationInfoSupport instance.

The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanOperationInfoSupport), and the name, signature, return open type and impact of the described operation and the string representation of its descriptor.

As OpenMBeanOperationInfoSupport instances are immutable, the string representation for this instance is calculated once, on the first call to toString, and then the same value is returned for subsequent calls.

Returns:String

a string representation of this OpenMBeanOperationInfoSupport instance