/* * Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code 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 * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.management.openmbean; // java import // import java.util.Set; import java.lang.Comparable; // to be substituted for jdk1.1.x // jmx import // /** *

Describes a parameter used in one or more operations or * constructors of an open MBean.

* *

This interface declares the same methods as the class {@link * javax.management.MBeanParameterInfo}. A class implementing this * interface (typically {@link OpenMBeanParameterInfoSupport}) should * extend {@link javax.management.MBeanParameterInfo}.

* * * @since 1.5 */ public interface OpenMBeanParameterInfo { // Re-declares methods that are in class MBeanParameterInfo of JMX 1.0 // (these will be removed when MBeanParameterInfo is made a parent interface of this interface) /** * Returns a human readable description of the parameter * described by this OpenMBeanParameterInfo instance. * * @return the description. */ public String getDescription() ; /** * Returns the name of the parameter * described by this OpenMBeanParameterInfo instance. * * @return the name. */ public String getName() ; // Now declares methods that are specific to open MBeans // /** * Returns the open type of the values of the parameter * described by this OpenMBeanParameterInfo instance. * * @return the open type. */ public OpenType getOpenType() ; /** * Returns the default value for this parameter, if it has one, or * null otherwise. * * @return the default value. */ public Object getDefaultValue() ; /** * Returns the set of legal values for this parameter, if it has * one, or null otherwise. * * @return the set of legal values. */ public Set getLegalValues() ; /** * Returns the minimal value for this parameter, if it has one, or * null otherwise. * * @return the minimum value. */ public Comparable getMinValue() ; /** * Returns the maximal value for this parameter, if it has one, or * null otherwise. * * @return the maximum value. */ public Comparable getMaxValue() ; /** * Returns true if this parameter has a specified default * value, or false otherwise. * * @return true if there is a default value. */ public boolean hasDefaultValue() ; /** * Returns true if this parameter has a specified set of * legal values, or false otherwise. * * @return true if there is a set of legal values. */ public boolean hasLegalValues() ; /** * Returns true if this parameter has a specified minimal * value, or false otherwise. * * @return true if there is a minimum value. */ public boolean hasMinValue() ; /** * Returns true if this parameter has a specified maximal * value, or false otherwise. * * @return true if there is a maximum value. */ public boolean hasMaxValue() ; /** * Tests whether obj is a valid value for the parameter * described by this OpenMBeanParameterInfo instance. * * @param obj the object to be tested. * * @return true if obj is a valid value * for the parameter described by this * OpenMBeanParameterInfo instance, * false otherwise. */ public boolean isValue(Object obj) ; /** * Compares the specified obj parameter with this OpenMBeanParameterInfo instance for equality. *

* Returns true if and only if all of the following statements are true: *

* This ensures that this equals method works properly for obj parameters which are * different implementations of the OpenMBeanParameterInfo interface. *
  * @param obj the object to be compared for equality with this OpenMBeanParameterInfo instance; * * @return true if the specified object is equal to this OpenMBeanParameterInfo instance. */ public boolean equals(Object obj); /** * Returns the hash code value for this OpenMBeanParameterInfo instance. *

* The hash code of an OpenMBeanParameterInfo instance is the sum of the hash codes * of all elements of information used in equals comparisons * (ie: its name, its open type, and its default, min, max and legal values). *

* This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() * for any two OpenMBeanParameterInfo instances t1 and t2, * as required by the general contract of the method * {@link Object#hashCode() Object.hashCode()}. *

* * @return the hash code value for this OpenMBeanParameterInfo instance */ public int hashCode(); /** * Returns a string representation of this OpenMBeanParameterInfo instance. *

* The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanParameterInfo), * the string representation of the name and open type of the described parameter, * and the string representation of its default, min, max and legal values. * * @return a string representation of this OpenMBeanParameterInfo instance */ public String toString(); }