001: /* JFox, the OpenSource J2EE Application Server
002: *
003: * Copyright (C) 2002 huihoo.org
004: * Distributable under GNU LGPL license
005: * See the GNU Lesser General Public License for more details.
006: */
007:
008: package javax.management.openmbean;
009:
010: /**
011: * <p>Describes an attribute of an open MBean.</p>
012: *
013: * <p>This interface declares the same methods as the class {@link
014: * javax.management.MBeanAttributeInfo}. A class implementing this
015: * interface (typically {@link OpenMBeanAttributeInfoSupport}) should
016: * extend {@link javax.management.MBeanAttributeInfo}.</p>
017: *
018: * @author <a href="mailto:young_yy@hotmail.org">Young Yang</a>
019: */
020:
021: public interface OpenMBeanAttributeInfo extends OpenMBeanParameterInfo {
022:
023: // Re-declares the methods that are in class MBeanAttributeInfo of JMX 1.0
024: // (these will be removed when MBeanAttributeInfo is made a parent interface of this interface)
025:
026: /**
027: * Returns <tt>true</tt> if the attribute described by this <tt>OpenMBeanAttributeInfo</tt> instance is readable,
028: * <tt>false</tt> otherwise.
029: *
030: * @return true if the attribute is readable.
031: */
032: public boolean isReadable();
033:
034: /**
035: * Returns <tt>true</tt> if the attribute described by this <tt>OpenMBeanAttributeInfo</tt> instance is writable,
036: * <tt>false</tt> otherwise.
037: *
038: * @return true if the attribute is writable.
039: */
040: public boolean isWritable();
041:
042: /**
043: * Returns <tt>true</tt> if the attribute described by this <tt>OpenMBeanAttributeInfo</tt> instance
044: * is accessed through a <tt>is<i>XXX</i></tt> getter (applies only to <tt>boolean</tt> and <tt>Boolean</tt> values),
045: * <tt>false</tt> otherwise.
046: *
047: * @return true if the attribute is accessed through <tt>is<i>XXX</i></tt>.
048: */
049: public boolean isIs();
050:
051: // commodity methods
052: //
053:
054: /**
055: * Compares the specified <var>obj</var> parameter with this <code>OpenMBeanAttributeInfo</code> instance for equality.
056: * <p>
057: * Returns <tt>true</tt> if and only if all of the following statements are true:
058: * <ul>
059: * <li><var>obj</var> is non null,</li>
060: * <li><var>obj</var> also implements the <code>OpenMBeanAttributeInfo</code> interface,</li>
061: * <li>their names are equal</li>
062: * <li>their open types are equal</li>
063: * <li>their access properties (isReadable, isWritable and isIs) are equal</li>
064: * <li>their default, min, max and legal values are equal.</li>
065: * </ul>
066: * This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
067: * different implementations of the <code>OpenMBeanAttributeInfo</code> interface.
068: * <br>
069: * @param obj the object to be compared for equality with this <code>OpenMBeanAttributeInfo</code> instance;
070: *
071: * @return <code>true</code> if the specified object is equal to this <code>OpenMBeanAttributeInfo</code> instance.
072: */
073: public boolean equals(Object obj);
074:
075: /**
076: * Returns the hash code value for this <code>OpenMBeanAttributeInfo</code> instance.
077: * <p>
078: * The hash code of an <code>OpenMBeanAttributeInfo</code> instance is the sum of the hash codes
079: * of all elements of information used in <code>equals</code> comparisons
080: * (ie: its name, its <i>open type</i>, and its default, min, max and legal values).
081: * <p>
082: * This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
083: * for any two <code>OpenMBeanAttributeInfo</code> instances <code>t1</code> and <code>t2</code>,
084: * as required by the general contract of the method
085: * {@link <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">
086: * <code>Object.hashCode</code> </a>}.
087: * <p>
088: *
089: * @return the hash code value for this <code>OpenMBeanAttributeInfo</code> instance
090: */
091: public int hashCode();
092:
093: /**
094: * Returns a string representation of this <code>OpenMBeanAttributeInfo</code> instance.
095: * <p>
096: * The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanAttributeInfo</code>),
097: * the string representation of the name and open type of the described attribute,
098: * and the string representation of its default, min, max and legal values.
099: *
100: * @return a string representation of this <code>OpenMBeanAttributeInfo</code> instance
101: */
102: public String toString();
103:
104: // methods specific to open MBeans are inherited from
105: // OpenMBeanParameterInfo
106: //
107:
108: }
|