01: /**
02: * Copyright (C) The MX4J Contributors.
03: * All rights reserved.
04: *
05: * This software is distributed under the terms of the MX4J License version 1.0.
06: * See the terms of the MX4J License in the documentation provided with this software.
07: */package javax.management.openmbean;
08:
09: /**
10: * An <code>OpenMBeanAttributeInfo</code> represents an attribute of
11: * an <code>OpenMBean</code>
12: *
13: * @version $Revision: 1.4 $
14: * @see OpenMBeanAttributeInfoSupport
15: */
16: public interface OpenMBeanAttributeInfo extends OpenMBeanParameterInfo {
17:
18: /**
19: * Returns true if the attribute is readable, false in not.
20: *
21: * @return boolean true of readable
22: */
23: public boolean isReadable();
24:
25: /**
26: * Returns true if the attribute is writable, false in not.
27: *
28: * @return boolean true of writable
29: */
30: public boolean isWritable();
31:
32: /**
33: * Returns true if the attribute described is accessed through a isXXX
34: * getter
35: * <p/>
36: * <p/>
37: * Note: applies only to boolean and Boolean values
38: * </p>
39: *
40: * @return boolean true if accessed through a isXXX
41: */
42: public boolean isIs();
43:
44: /**
45: * Compares the give <code>Object</code> for equality with this instance.
46: * <p/>
47: * <p/>
48: * The operation returns true if and only if the following statements
49: * are all true:
50: * <ul>
51: * <li>obj is not null</li>
52: * <li>obj also implements OpenMBeanAttributeInfo</li>
53: * <li>their names are equals</li>
54: * <li>their open types are equal</li>
55: * <li>access properties (isReadable, isWritable, isIs) are equal</li>
56: * <li>default,min,max and legal values are equal</li>
57: * </ul>
58: *
59: * @return boolean true if the above conditions are met
60: */
61: public boolean equals(Object obj);
62:
63: /**
64: * Computes the hashCode of this <code>OpenMBeanAttributeInfo</code>
65: *
66: * @return int The hashCode value
67: */
68: public int hashCode();
69:
70: /**
71: * Returns a string representation of this <code>OpenMBeanAttributeInfo</code> instance.
72: *
73: * @return String The representation as string
74: */
75: public String toString();
76: }
|