author | avstepan |
Thu, 06 Aug 2015 13:59:10 +0300 | |
changeset 32034 | 05676cfd40b5 |
parent 25859 | 3317bb8137f4 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
24368 | 2 |
* Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
||
27 |
package javax.management.openmbean; |
|
28 |
||
29 |
||
30 |
// java import |
|
31 |
// |
|
32 |
||
33 |
||
34 |
// jmx import |
|
35 |
// |
|
36 |
import javax.management.MBeanAttributeInfo; |
|
37 |
import javax.management.MBeanOperationInfo; |
|
38 |
import javax.management.MBeanConstructorInfo; |
|
39 |
import javax.management.MBeanNotificationInfo; |
|
40 |
||
41 |
||
42 |
||
43 |
/** |
|
44 |
* <p>Describes an Open MBean: an Open MBean is recognized as such if |
|
45 |
* its {@link javax.management.DynamicMBean#getMBeanInfo() |
|
46 |
* getMBeanInfo()} method returns an instance of a class which |
|
47 |
* implements the {@link OpenMBeanInfo} interface, typically {@link |
|
48 |
* OpenMBeanInfoSupport}.</p> |
|
49 |
* |
|
50 |
* <p>This interface declares the same methods as the class {@link |
|
51 |
* javax.management.MBeanInfo}. A class implementing this interface |
|
52 |
* (typically {@link OpenMBeanInfoSupport}) should extend {@link |
|
53 |
* javax.management.MBeanInfo}.</p> |
|
54 |
* |
|
55 |
* <p>The {@link #getAttributes()}, {@link #getOperations()} and |
|
56 |
* {@link #getConstructors()} methods of the implementing class should |
|
57 |
* return at runtime an array of instances of a subclass of {@link |
|
58 |
* MBeanAttributeInfo}, {@link MBeanOperationInfo} or {@link |
|
59 |
* MBeanConstructorInfo} respectively which implement the {@link |
|
60 |
* OpenMBeanAttributeInfo}, {@link OpenMBeanOperationInfo} or {@link |
|
61 |
* OpenMBeanConstructorInfo} interface respectively. |
|
62 |
* |
|
63 |
* |
|
64 |
* @since 1.5 |
|
65 |
*/ |
|
66 |
public interface OpenMBeanInfo { |
|
67 |
||
68 |
// Re-declares the methods that are in class MBeanInfo of JMX 1.0 |
|
69 |
// (methods will be removed when MBeanInfo is made a parent interface of this interface) |
|
70 |
||
71 |
/** |
|
72 |
* Returns the fully qualified Java class name of the open MBean |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
73 |
* instances this {@code OpenMBeanInfo} describes. |
2 | 74 |
* |
75 |
* @return the class name. |
|
76 |
*/ |
|
77 |
public String getClassName() ; |
|
78 |
||
79 |
/** |
|
80 |
* Returns a human readable description of the type of open MBean |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
81 |
* instances this {@code OpenMBeanInfo} describes. |
2 | 82 |
* |
83 |
* @return the description. |
|
84 |
*/ |
|
85 |
public String getDescription() ; |
|
86 |
||
87 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
88 |
* Returns an array of {@code OpenMBeanAttributeInfo} instances |
2 | 89 |
* describing each attribute in the open MBean described by this |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
90 |
* {@code OpenMBeanInfo} instance. Each instance in the returned |
2 | 91 |
* array should actually be a subclass of |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
92 |
* {@code MBeanAttributeInfo} which implements the |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
93 |
* {@code OpenMBeanAttributeInfo} interface (typically {@link |
2 | 94 |
* OpenMBeanAttributeInfoSupport}). |
95 |
* |
|
96 |
* @return the attribute array. |
|
97 |
*/ |
|
98 |
public MBeanAttributeInfo[] getAttributes() ; |
|
99 |
||
100 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
101 |
* Returns an array of {@code OpenMBeanOperationInfo} instances |
2 | 102 |
* describing each operation in the open MBean described by this |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
103 |
* {@code OpenMBeanInfo} instance. Each instance in the returned |
2 | 104 |
* array should actually be a subclass of |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
105 |
* {@code MBeanOperationInfo} which implements the |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
106 |
* {@code OpenMBeanOperationInfo} interface (typically {@link |
2 | 107 |
* OpenMBeanOperationInfoSupport}). |
108 |
* |
|
109 |
* @return the operation array. |
|
110 |
*/ |
|
111 |
public MBeanOperationInfo[] getOperations() ; |
|
112 |
||
113 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
114 |
* Returns an array of {@code OpenMBeanConstructorInfo} instances |
2 | 115 |
* describing each constructor in the open MBean described by this |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
116 |
* {@code OpenMBeanInfo} instance. Each instance in the returned |
2 | 117 |
* array should actually be a subclass of |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
118 |
* {@code MBeanConstructorInfo} which implements the |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
119 |
* {@code OpenMBeanConstructorInfo} interface (typically {@link |
2 | 120 |
* OpenMBeanConstructorInfoSupport}). |
121 |
* |
|
122 |
* @return the constructor array. |
|
123 |
*/ |
|
124 |
public MBeanConstructorInfo[] getConstructors() ; |
|
125 |
||
126 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
127 |
* Returns an array of {@code MBeanNotificationInfo} instances |
2 | 128 |
* describing each notification emitted by the open MBean |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
129 |
* described by this {@code OpenMBeanInfo} instance. |
2 | 130 |
* |
131 |
* @return the notification array. |
|
132 |
*/ |
|
133 |
public MBeanNotificationInfo[] getNotifications() ; |
|
134 |
||
135 |
||
136 |
// commodity methods |
|
137 |
// |
|
138 |
||
139 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
140 |
* Compares the specified <var>obj</var> parameter with this {@code OpenMBeanInfo} instance for equality. |
2 | 141 |
* <p> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
142 |
* Returns {@code true} if and only if all of the following statements are true: |
2 | 143 |
* <ul> |
144 |
* <li><var>obj</var> is non null,</li> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
145 |
* <li><var>obj</var> also implements the {@code OpenMBeanInfo} interface,</li> |
2 | 146 |
* <li>their class names are equal</li> |
147 |
* <li>their infos on attributes, constructors, operations and notifications are equal</li> |
|
148 |
* </ul> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
149 |
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
150 |
* different implementations of the {@code OpenMBeanInfo} interface. |
2 | 151 |
* |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
152 |
* @param obj the object to be compared for equality with this {@code OpenMBeanInfo} instance; |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
153 |
* |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
154 |
* @return {@code true} if the specified object is equal to this {@code OpenMBeanInfo} instance. |
2 | 155 |
*/ |
156 |
public boolean equals(Object obj); |
|
157 |
||
158 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
159 |
* Returns the hash code value for this {@code OpenMBeanInfo} instance. |
2 | 160 |
* <p> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
161 |
* The hash code of an {@code OpenMBeanInfo} instance is the sum of the hash codes |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
162 |
* of all elements of information used in {@code equals} comparisons |
2 | 163 |
* (ie: its class name, and its infos on attributes, constructors, operations and notifications, |
164 |
* where the hashCode of each of these arrays is calculated by a call to |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
165 |
* {@code new java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()}). |
2 | 166 |
* <p> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
167 |
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()} |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
168 |
* for any two {@code OpenMBeanInfo} instances {@code t1} and {@code t2}, |
2 | 169 |
* as required by the general contract of the method |
170 |
* {@link Object#hashCode() Object.hashCode()}. |
|
171 |
* |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
172 |
* @return the hash code value for this {@code OpenMBeanInfo} instance |
2 | 173 |
*/ |
174 |
public int hashCode(); |
|
175 |
||
176 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
177 |
* Returns a string representation of this {@code OpenMBeanInfo} instance. |
2 | 178 |
* <p> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
179 |
* The string representation consists of the name of this class |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
180 |
* (ie {@code javax.management.openmbean.OpenMBeanInfo}), the MBean class name, |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
181 |
* and the string representation of infos on attributes, constructors, |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
182 |
* operations and notifications of the described MBean. |
2 | 183 |
* |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
184 |
* @return a string representation of this {@code OpenMBeanInfo} instance |
2 | 185 |
*/ |
186 |
public String toString(); |
|
187 |
||
188 |
} |