Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.management.openmbean

Interface OpenMBeanOperationInfo

Known Implementing Classes:
OpenMBeanOperationInfoSupport
public interface OpenMBeanOperationInfo
Describes a operation for an open management bean. This interface includes those methods specified by MBeanOperationInfo, so implementations should extend this class. The getSignature() method should return an array containing instances of OpenMBeanParameterInfo.
Since:
1.5

Method Summary

boolean
equals(Object obj)
Compares this attribute with the supplied object.
String
getDescription()
Returns a description of this operation.
int
getImpact()
Returns the impact of performing this operation.
String
getName()
Returns the name of this operation.
OpenType
getReturnOpenType()
Returns the open type instance which represents the type of the return value.
String
getReturnType()
Returns the return type of the operation, as the class name.
MBeanParameterInfo[]
getSignature()
Returns the operation's signature, in the form of information on each parameter.
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.

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.
Overrides:
equals in interface Object
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().

getDescription

public String getDescription()
Returns a description of this operation.
Returns:
a human-readable description.

getImpact

public int getImpact()
Returns the impact of performing this operation. The value is equal to one of the following:
  1. MBeanOperationInfo.INFO — the method just returns information (akin to an accessor).
  2. MBeanOperationInfo.ACTION the method just alters the state of the bean, without returning a value (akin to a mutator).
  3. MBeanOperationInfo.ACTION_INFO the method both makes state changes and returns a value.
  4. MBeanOperationInfo.UNKNOWN the behaviour of the operation is unknown.
Returns:
the impact of performing the operation.

getName

public String getName()
Returns the name of this operation.
Returns:
the name of the operation.

getReturnOpenType

public OpenType getReturnOpenType()
Returns the open type instance which represents the type of the return value.
Returns:
the open type of the return value.

getReturnType

public String getReturnType()
Returns the return type of the operation, as the class name. This should be identical to getReturnOpenType.getClassName().
Returns:
the return type.

getSignature

public MBeanParameterInfo[] getSignature()
Returns the operation's signature, in the form of information on each parameter. Each parameter is described by an instance of OpenMBeanParameterInfo.
Returns:
an array of OpenMBeanParameterInfo objects, describing the operation parameters.

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()).
Overrides:
hashCode in interface Object
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.
Overrides:
toString in interface Object
Returns:
a @link{java.lang.String} instance representing the instance in textual form.
OpenMBeanOperationInfo.java -- Open typed info about a operation. Copyright (C) 2006 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.

Overview Package Class Use Source Tree Index Deprecated About