001/* OpenMBeanConstructorInfo.java -- Open typed info about a constructor.
002   Copyright (C) 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.management.openmbean;
039
040import javax.management.MBeanParameterInfo;
041
042/**
043 * Describes a constructor for an open management bean.
044 * This interface includes those methods specified by {@link
045 * javax.management.MBeanConstructorInfo}, so implementations should
046 * extend this class.  The {@link #getSignature()} method should
047 * return an array containing instances of {@link OpenMBeanParameterInfo}.
048 *
049 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
050 * @since 1.5
051 */
052public interface OpenMBeanConstructorInfo
053{
054
055  /**
056   * Compares this attribute with the supplied object.  This returns
057   * true iff the object is an instance of {@link OpenMBeanConstructorInfo}
058   * with an equal name and signature.
059   *
060   * @param obj the object to compare.
061   * @return true if the object is a {@link OpenMBeanParameterInfo}
062   *         instance,
063   *         <code>name.equals(object.getName())</code>,
064   *         and <code>signature.equals(object.getSignature())</code>.
065   */
066  boolean equals(Object obj);
067
068  /**
069   * Returns a description of this constructor.
070   *
071   * @return a human-readable description.
072   */
073  String getDescription();
074
075  /**
076   * Returns the name of this constructor.
077   *
078   * @return the name of the constructor.
079   */
080  String getName();
081
082  /**
083   * Returns the constructor's signature, in the form of
084   * information on each parameter.  Each parameter is
085   * described by an instance of {@link OpenMBeanParameterInfo}.
086   *
087   * @return an array of {@link OpenMBeanParameterInfo} objects,
088   *         describing the constructor parameters.
089   */
090  MBeanParameterInfo[] getSignature();
091
092  /**
093   * Returns the hashcode of the constructor information as the sum of
094   * the hashcodes of the name and signature (calculated by
095   * <code>java.util.Arrays.asList(signature).hashCode()</code>).
096   *
097   * @return the hashcode of the constructor information.
098   */
099  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}