|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.management.relation.RoleInfo
A RoleInfo object represents a role information in a relation type.
Field Summary | |
static int |
ROLE_CARDINALITY_INFINITY
To specify an unlimited cardinality |
Constructor Summary | |
RoleInfo(RoleInfo theRoleInfo)
Copy constructor |
|
RoleInfo(java.lang.String theName,
java.lang.String theRefMBeanClassName)
Constructor to create RoleInfo |
|
RoleInfo(java.lang.String theName,
java.lang.String theRefMBeanClassName,
boolean theIsReadable,
boolean theIsWritable)
Constructor to create RoleInfo |
|
RoleInfo(java.lang.String theName,
java.lang.String theRefMBeanClassName,
boolean theIsReadable,
boolean theIsWritable,
int theMinDegree,
int theMaxDegree,
java.lang.String theDescription)
Constructor to create RoleInfo |
Method Summary | |
boolean |
checkMaxDegree(int theValue)
Returns a boolean to specify if given value is less or equal than expected maximum degree (true if yes) |
boolean |
checkMinDegree(int theValue)
Returns a boolean to specify if given value is greater or equal than expected minimum degree (true if yes) |
java.lang.String |
getDescription()
Returns description text for the role |
int |
getMaxDegree()
Returns maximum degree for corresponding role reference |
int |
getMinDegree()
Returns minimum degree for corresponding role reference |
java.lang.String |
getName()
Returns the name of the role |
java.lang.String |
getRefMBeanClassName()
Returns name of class of MBean expected to be referenced in corresponding role |
boolean |
isReadable()
Returns read access mode for the role (true if it is readable) |
boolean |
isWritable()
Returns write access mode for the role (true if it is writable) |
java.lang.String |
toString()
Prints a string describing the role info Overrides: toString in class java.lang.Object |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static int ROLE_CARDINALITY_INFINITY
Constructor Detail |
public RoleInfo(RoleInfo theRoleInfo) throws java.lang.IllegalArgumentException
theRoleInfo
- RoleInfo objectjava.lang.IllegalArgumentException
- - if null parameterpublic RoleInfo(java.lang.String theName, java.lang.String theRefMBeanClassName) throws java.lang.IllegalArgumentException, java.lang.ClassNotFoundException, NotCompliantMBeanException
theName
- - name of the roletheRefMBeanClassName
- - name of the class of MBean(s) expected
to be referenced in corresponding role Readable and
IsWritable defaulted to true.
Minimum and maximum degrees defaulted to 1.
Description of role defaulted to null.java.lang.IllegalArgumentException
- - if null parameterjava.lang.ClassNotFoundException
- - if the class
theMBeanClassName does not exist.NotCompliantMBeanException
- - if the class
theRefMBeanClassName is not a MBean class.public RoleInfo(java.lang.String theName, java.lang.String theRefMBeanClassName, boolean theIsReadable, boolean theIsWritable) throws java.lang.IllegalArgumentException, java.lang.ClassNotFoundException, NotCompliantMBeanException
theName
- - name of the roletheRefMBeanClassName
- - name of the class of MBean(s) expected to
be referenced in corresponding roletheIsReadable
- - flag to indicate if the corresponding role can be readtheIsWritable
- - flag to indicate if the corresponding role can be set
Minimum and maximum degrees defaulted to 1.
Description of role defaulted to null.java.lang.IllegalArgumentException
- - if null parameterjava.lang.ClassNotFoundException
- - if the class
theMBeanClassName does not exist.NotCompliantMBeanException
- - if the class
theRefMBeanClassName is not a MBean class.public RoleInfo(java.lang.String theName, java.lang.String theRefMBeanClassName, boolean theIsReadable, boolean theIsWritable, int theMinDegree, int theMaxDegree, java.lang.String theDescription) throws java.lang.IllegalArgumentException, InvalidRoleInfoException, java.lang.ClassNotFoundException, NotCompliantMBeanException
theName
- - name of the roletheRefMBeanClassName
- - name of the class of MBean(s) expected to
be referenced in corresponding roletheIsReadable
- - flag to indicate if the corresponding role can be readtheIsWritable
- - flag to indicate if the corresponding role can be settheMinDegree
- - minimum degree for role, i.e. minimum number of
MBeans to provide in corresponding role Must be less or
equal than theMaxDegree.
(ROLE_CARDINALITY_INFINITY for unlimited)theMaxDegree
- - maximum degree for role, i.e. maximum number of
MBeans to provide in corresponding role Must be greater or
equal than theMinDegree
(ROLE_CARDINALITY_INFINITY for unlimited)theDescription
- - description of the role (can be null)java.lang.IllegalArgumentException
- - if null parameterInvalidRoleInfoException
- - if the minimum degree is greater than
the maximum degree.java.lang.ClassNotFoundException
- - if the class
theRefMBeanClassName does not exist.NotCompliantMBeanException
- - if the class
theRefMBeanClassName is not a MBean class.Method Detail |
public boolean checkMaxDegree(int theValue)
theValue
- - valuepublic boolean checkMinDegree(int theValue)
theValue
- - valuepublic java.lang.String getDescription()
public int getMaxDegree()
public int getMinDegree()
public java.lang.String getName()
public java.lang.String getRefMBeanClassName()
public boolean isReadable()
public boolean isWritable()
public java.lang.String toString()
toString
in class java.lang.Object
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |