Source for javax.management.openmbean.OpenMBeanOperationInfo

   1: /* OpenMBeanOperationInfo.java -- Open typed info about a operation.
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management.openmbean;
  39: 
  40: import javax.management.MBeanParameterInfo;
  41: 
  42: /**
  43:  * Describes a operation for an open management bean.
  44:  * This interface includes those methods specified by {@link
  45:  * javax.management.MBeanOperationInfo}, so implementations should
  46:  * extend this class.  The {@link #getSignature()} method should
  47:  * return an array containing instances of {@link OpenMBeanParameterInfo}.
  48:  *
  49:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  50:  * @since 1.5
  51:  */
  52: public interface OpenMBeanOperationInfo
  53: {
  54: 
  55:   /**
  56:    * Compares this attribute with the supplied object.  This returns
  57:    * true iff the object is an instance of {@link OpenMBeanOperationInfo}
  58:    * with an equal name, signature, open return type and impact.
  59:    *
  60:    * @param obj the object to compare.
  61:    * @return true if the object is a {@link OpenMBeanParameterInfo}
  62:    *         instance, 
  63:    *         <code>name.equals(object.getName())</code>,
  64:    *         <code>signature.equals(object.getSignature())</code>,
  65:    *         <code>returnOpenType.equals(object.getReturnOpenType())</code>,
  66:    *         and <code>impact == object.getImpact()</code>.
  67:    */
  68:   boolean equals(Object obj);
  69: 
  70:   /**
  71:    * Returns a description of this operation.
  72:    *
  73:    * @return a human-readable description.
  74:    */
  75:   String getDescription();
  76: 
  77:   /**
  78:    * <p>
  79:    * Returns the impact of performing this operation.
  80:    * The value is equal to one of the following:
  81:    * </p>
  82:    * <ol>
  83:    * <li>{@link javax.management.MBeanOperationInfo#INFO}
  84:    * &mdash; the method just returns
  85:    * information (akin to an accessor).</li>
  86:    * <li>{@link javax.management.MBeanOperationInfo#ACTION}
  87:    * the method just alters the state of the bean, without
  88:    * returning a value (akin to a mutator).</li>
  89:    * <li>{@link javax.management.MBeanOperationInfo#ACTION_INFO}
  90:    * the method both makes state changes and returns a value.</li>
  91:    * <li>{@link javax.management.MBeanOperationInfo#UNKNOWN}
  92:    * the behaviour of the operation is unknown.</li>
  93:    * </ol>
  94:    *
  95:    * @return the impact of performing the operation.
  96:    */
  97:   int getImpact();
  98: 
  99:   /**
 100:    * Returns the name of this operation.
 101:    *
 102:    * @return the name of the operation.
 103:    */
 104:   String getName();
 105: 
 106:   /**
 107:    * Returns the open type instance which represents the type of the
 108:    * return value.
 109:    *
 110:    * @return the open type of the return value.
 111:    */
 112:   OpenType<?> getReturnOpenType();
 113: 
 114:   /**
 115:    * Returns the return type of the operation, as the class
 116:    * name.  This should be identical to
 117:    * <code>getReturnOpenType.getClassName()</code>.
 118:    *
 119:    * @return the return type.
 120:    */
 121:   String getReturnType();
 122: 
 123:   /**
 124:    * Returns the operation's signature, in the form of
 125:    * information on each parameter.  Each parameter is
 126:    * described by an instance of {@link OpenMBeanParameterInfo}.
 127:    *
 128:    * @return an array of {@link OpenMBeanParameterInfo} objects,
 129:    *         describing the operation parameters.
 130:    */
 131:   MBeanParameterInfo[] getSignature();
 132: 
 133:   /**
 134:    * Returns the hashcode of the operation information as the sum of
 135:    * the hashcodes of the name, open return type, impact and signature
 136:    * (calculated by
 137:    * <code>java.util.Arrays.asList(signature).hashCode()</code>).
 138:    *
 139:    * @return the hashcode of the operation information.
 140:    */
 141:   int hashCode();
 142: 
 143:   /**
 144:    * Returns a textual representation of this instance.  This
 145:    * is constructed using the class name
 146:    * (<code>javax.management.openmbean.OpenMBeanOperationInfo</code>)
 147:    * along with the name, signature, open return type and impact.
 148:    *
 149:    * @return a @link{java.lang.String} instance representing
 150:    *         the instance in textual form.
 151:    */
 152:   String toString();
 153: 
 154: }