javax.management.openmbean

Class OpenMBeanOperationInfoSupport

Implemented Interfaces:
Cloneable, OpenMBeanOperationInfo, Serializable

public class OpenMBeanOperationInfoSupport
extends MBeanOperationInfo
implements OpenMBeanOperationInfo

Describes a operation for an open management bean.
Since:
1.5
See Also:
Serialized Form

Field Summary

Fields inherited from class javax.management.MBeanOperationInfo

ACTION, ACTION_INFO, INFO, UNKNOWN

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

Constructor Summary

OpenMBeanOperationInfoSupport(String name, String desc, OpenMBeanParameterInfo[] sig, OpenType type, int impact)
Constructs a @link{OpenMBeanOperationInfo} with the specified name, description, parameter information, open return type and impact.

Method Summary

boolean
equals(Object obj)
Compares this attribute with the supplied object.
OpenType
getReturnOpenType()
Returns the open type instance which represents the type of the return value.
int
hashCode()
Returns the hashcode of the operation information as the sum of the hashcodes of the name, open return type, impact and signature (calculated by java.util.Arrays.asList(signature).hashCode()).
String
toString()
Returns a textual representation of this instance.

Methods inherited from class javax.management.MBeanOperationInfo

clone, equals, getImpact, getReturnType, getSignature, hashCode, toString

Methods inherited from class javax.management.MBeanFeatureInfo

equals, getDescription, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenMBeanOperationInfoSupport

public OpenMBeanOperationInfoSupport(String name,
                                     String desc,
                                     OpenMBeanParameterInfo[] sig,
                                     OpenType type,
                                     int impact)
Constructs a @link{OpenMBeanOperationInfo} with the specified name, description, parameter information, open return type and impact. A null value for the parameter information is the same as passing in an empty array. A copy of the parameter array is taken, so later changes have no effect. The name and the description may not be equal to the empty string, and neither the name, description nor the open return type may be null. The value of impact must be one of the four valid values (MBeanOperationInfo.INFO, MBeanOperationInfo.ACTION, MBeanOperationInfo.ACTION_INFO and MBeanOperationInfo.UNKNOWN).
Parameters:
name - the name of the constructor.
desc - a description of the attribute.
sig - the signature of the method, as a series of MBeanParameterInfo objects, one for each parameter.
type - the open return type of the method.
impact - the impact of performing the operation.
Throws:
IllegalArgumentException - if the name, description or open return type is null, the name or description are equal to the empty string, or the impact factor is not one of the values enumerated above.
ArrayStoreException - if the members of the signature array are not assignable to MBeanParameterInfo

Method Details

equals

public boolean equals(Object obj)
Compares this attribute with the supplied object. This returns true iff the object is an instance of OpenMBeanOperationInfo with an equal name, signature, open return type and impact.
Specified by:
equals in interface OpenMBeanOperationInfo
Overrides:
equals in interface MBeanOperationInfo
Parameters:
obj - the object to compare.
Returns:
true if the object is a OpenMBeanParameterInfo instance, name.equals(object.getName()), signature.equals(object.getSignature()), returnOpenType.equals(object.getReturnOpenType()), and impact == object.getImpact().

getReturnOpenType

public OpenType getReturnOpenType()
Returns the open type instance which represents the type of the return value.
Specified by:
getReturnOpenType in interface OpenMBeanOperationInfo
Returns:
the open type of the return value.

hashCode

public int hashCode()
Returns the hashcode of the operation information as the sum of the hashcodes of the name, open return type, impact and signature (calculated by java.util.Arrays.asList(signature).hashCode()).

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Specified by:
hashCode in interface OpenMBeanOperationInfo
Overrides:
hashCode in interface MBeanOperationInfo
Returns:
the hashcode of the operation information.

toString

public String toString()
Returns a textual representation of this instance. This is constructed using the class name (javax.management.openmbean.OpenMBeanOperationInfo) along with the name, signature, open return type and impact.

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Specified by:
toString in interface OpenMBeanOperationInfo
Overrides:
toString in interface MBeanOperationInfo
Returns:
a @link{java.lang.String} instance representing the instance in textual form.

OpenMBeanOperationInfoSupport.java -- Open typed info about an operation. Copyright (C) 2006, 2007 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.