| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
HashMap infos = …;
String roleName = …;
RoleInfo info = (RoleInfo)infos.get(roleName);
Based on 9 examples
public class RoleInfo extends Object implements Serializable
A RoleInfo object summarises a role in a relation type.
The serialVersionUID of this class is 2504952983494636987L
.
Field Summary | |
---|---|
static int |
ROLE_CARDINALITY_INFINITY
To specify an unlimited cardinality. |
Constructor Summary | |
---|---|
Copy constructor. |
|
Constructor. |
|
Constructor. |
|
Constructor. |
Method Summary | |
---|---|
boolean |
checkMaxDegree(int value) Returns true if the value parameter is lower than or equal to the expected maximum degree, false otherwise. |
boolean |
checkMinDegree(int value) Returns true if the value parameter is greater than or equal to the expected minimum degree, false otherwise. |
String |
Returns description text for the role. |
int |
Returns maximum degree for corresponding role reference. |
int |
Returns minimum degree for corresponding role reference. |
String |
getName() Returns the name of the role. |
String |
Returns name of type of MBean expected to be referenced in corresponding role. |
boolean |
Returns read access mode for the role (true if it is readable). |
boolean |
Returns write access mode for the role (true if it is writable). |
String |
toString() Returns a string describing the role info. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ROLE_CARDINALITY_INFINITY
Constructor Detail |
---|
public RoleInfo(RoleInfo roleInfo) throws IllegalArgumentException
roleInfo
- the RoleInfo instance to be copied.IllegalArgumentException
- if null parameterpublic RoleInfo(String roleName, String mbeanClassName) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException
roleName
- name of the rolembeanClassName
- name of the class of MBean(s) expected to
be referenced in corresponding role. If an MBean M is in
this role, then the MBean server must return true for
{@link MBeanServer#isInstanceOf isInstanceOf(M, mbeanClassName)}.
IsReadable and IsWritable defaulted to true.
Minimum and maximum degrees defaulted to 1.
Description of role defaulted to null.
IllegalArgumentException
- if null parameterClassNotFoundException
- As of JMX 1.2, this exception
can no longer be thrown. It is retained in the declaration of
this class for compatibility with existing code.NotCompliantMBeanException
- As of JMX 1.2, this
exception can no longer be thrown. It is retained in the
declaration of this class for compatibility with existing code.public RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException
roleName
- name of the rolembeanClassName
- name of the class of MBean(s) expected to
be referenced in corresponding role. If an MBean M is in
this role, then the MBean server must return true for
{@link MBeanServer#isInstanceOf isInstanceOf(M, mbeanClassName)}.read
- flag to indicate if the corresponding role
can be readwrite
- flag to indicate if the corresponding role
can be set
Minimum and maximum degrees defaulted to 1.
Description of role defaulted to null.
IllegalArgumentException
- if null parameterClassNotFoundException
- As of JMX 1.2, this exception
can no longer be thrown. It is retained in the declaration of
this class for compatibility with existing code.NotCompliantMBeanException
- As of JMX 1.2, this
exception can no longer be thrown. It is retained in the
declaration of this class for compatibility with existing code.public RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr) throws IllegalArgumentException, InvalidRoleInfoException, ClassNotFoundException, NotCompliantMBeanException
roleName
- name of the role.mbeanClassName
- name of the class of MBean(s) expected to
be referenced in corresponding role. If an MBean M is in
this role, then the MBean server must return true for
{@link MBeanServer#isInstanceOf isInstanceOf(M, mbeanClassName)}.read
- flag to indicate if the corresponding role
can be readwrite
- flag to indicate if the corresponding role
can be setmin
- minimum degree for role, i.e. minimum number of
MBeans to provide in corresponding role
Must be less than or equal to max.
(ROLE_CARDINALITY_INFINITY for unlimited)max
- maximum degree for role, i.e. maximum number of
MBeans to provide in corresponding role
Must be greater than or equal to min
(ROLE_CARDINALITY_INFINITY for unlimited)descr
- description of the role (can be null)IllegalArgumentException
- if null parameterInvalidRoleInfoException
- if the minimum degree is
greater than the maximum degree.ClassNotFoundException
- As of JMX 1.2, this exception
can no longer be thrown. It is retained in the declaration of
this class for compatibility with existing code.NotCompliantMBeanException
- if the class mbeanClassName
is not a MBean class.Method Detail |
---|
public boolean checkMaxDegree(int value)
value
- the value to be checkedpublic boolean checkMinDegree(int value)
value
- the value to be checkedpublic String getDescription()
public int getMaxDegree()
public int getMinDegree()
public String getName()
public String getRefMBeanClassName()
Returns name of type of MBean expected to be referenced in corresponding role.
public boolean isReadable()
public boolean isWritable()
public String toString()
toString
in class Object
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |