001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package javax.management.openmbean;
023:
024: import java.util.Set;
025:
026: /**
027: * An open MBean parameter info implements this interface as well as extending
028: * MBeanParameterInfo.<p>
029: *
030: * {@link OpenMBeanParameterInfoSupport} is an example of such a class.
031: *
032: * @author <a href="mailto:Adrian.Brock@HappeningTimes.com">Adrian Brock</a>.
033: *
034: * @version $Revision: 57200 $
035: *
036: */
037: public interface OpenMBeanParameterInfo {
038: // Attributes ----------------------------------------------------
039:
040: // Constructors --------------------------------------------------
041:
042: // Public --------------------------------------------------------
043:
044: /**
045: * Retrieve a human readable description of the open MBean parameter the
046: * implementation of this interface describes.
047: *
048: * @return the description.
049: */
050: String getDescription();
051:
052: /**
053: * Retrieve the name of the parameter described.
054: *
055: * @return the name.
056: */
057: String getName();
058:
059: /**
060: * Retrieve the open type for this parameter
061: *
062: * @return the open type.
063: */
064: OpenType getOpenType();
065:
066: /**
067: * Retrieve the default value for this parameter or null if there is no
068: * default
069: *
070: * @return the default value
071: */
072: Object getDefaultValue();
073:
074: /**
075: * Retrieve the legal values values for this parameter or null if this
076: * is not specified
077: *
078: * @return the legal value
079: */
080: Set getLegalValues();
081:
082: /**
083: * Retrieve the minimum values values for this parameter or null if this
084: * is not specified
085: *
086: * @return the minimum value
087: */
088: Comparable getMinValue();
089:
090: /**
091: * Retrieve the maximum values values for this parameter or null if this
092: * is not specified
093: *
094: * @return the maximum value
095: */
096: Comparable getMaxValue();
097:
098: /**
099: * Discover wether this parameter has a default value specified
100: *
101: * @return true when a default value is specified or false otherwise
102: */
103: boolean hasDefaultValue();
104:
105: /**
106: * Discover wether this parameter has legal values specified
107: *
108: * @return true when the legal values are specified or false otherwise
109: */
110: boolean hasLegalValues();
111:
112: /**
113: * Discover wether this parameter has a minimum value specified
114: *
115: * @return true when a minimum value is specified or false otherwise
116: */
117: boolean hasMinValue();
118:
119: /**
120: * Discover wether this parameter has a maximum value specified
121: *
122: * @return true when a maximum value is specified or false otherwise
123: */
124: boolean hasMaxValue();
125:
126: /**
127: * Tests whether an object is acceptable as a paramter value
128: *
129: * @param obj the object to test
130: * @return true when it is a valid value, or false otherwise
131: */
132: boolean isValue(Object obj);
133:
134: /**
135: * Compares an object for equality with the implementing class.<p>
136: *
137: * The object is not null<br>
138: * The object implements the open mbean attribute info interface<br>
139: * The parameter names are equal<br>
140: * The open types are equal<br>
141: * The default, min, max and legal values are equal
142: *
143: * @param obj the object to test
144: * @return true when above is true, false otherwise
145: */
146: boolean equals(Object obj);
147:
148: /**
149: * Generates a hashcode for the implementation.<p>
150: *
151: * The sum of the hashCodes for the elements mentioned in the equals
152: * method
153: *
154: * @return the calculated hashcode
155: */
156: int hashCode();
157:
158: /**
159: * A string representation of the open mbean parameter info.<p>
160: *
161: * It is made up of implementation class and the values mentioned
162: * in the equals method
163: *
164: * @return the string
165: */
166: String toString();
167: }
|