Source for javax.management.openmbean.OpenMBeanConstructorInfo

   1: /* OpenMBeanConstructorInfo.java -- Open typed info about a constructor.
   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 constructor for an open management bean.
  44:  * This interface includes those methods specified by {@link
  45:  * javax.management.MBeanConstructorInfo}, 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 OpenMBeanConstructorInfo
  53: {
  54: 
  55:   /**
  56:    * Compares this attribute with the supplied object.  This returns
  57:    * true iff the object is an instance of {@link OpenMBeanConstructorInfo}
  58:    * with an equal name and signature.
  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:    *         and <code>signature.equals(object.getSignature())</code>.
  65:    */
  66:   boolean equals(Object obj);
  67: 
  68:   /**
  69:    * Returns a description of this constructor.
  70:    *
  71:    * @return a human-readable description.
  72:    */
  73:   String getDescription();
  74: 
  75:   /**
  76:    * Returns the name of this constructor.
  77:    *
  78:    * @return the name of the constructor.
  79:    */
  80:   String getName();
  81: 
  82:   /**
  83:    * Returns the constructor's signature, in the form of
  84:    * information on each parameter.  Each parameter is
  85:    * described by an instance of {@link OpenMBeanParameterInfo}.
  86:    *
  87:    * @return an array of {@link OpenMBeanParameterInfo} objects,
  88:    *         describing the constructor parameters.
  89:    */
  90:   MBeanParameterInfo[] getSignature();
  91: 
  92:   /**
  93:    * Returns the hashcode of the constructor information as the sum of
  94:    * the hashcodes of the name and signature (calculated by
  95:    * <code>java.util.Arrays.asList(signature).hashCode()</code>).
  96:    *
  97:    * @return the hashcode of the constructor information.
  98:    */
  99:   int hashCode();
 100: 
 101:   /**
 102:    * Returns a textual representation of this instance.  This
 103:    * is constructed using the class name
 104:    * (<code>javax.management.openmbean.OpenMBeanConstructorInfo</code>)
 105:    * along with the name and signature.
 106:    *
 107:    * @return a @link{java.lang.String} instance representing
 108:    *         the instance in textual form.
 109:    */
 110:   String toString();
 111: 
 112: }