XMOJO 5 API Docs

javax.management.relation
Class Role

java.lang.Object
  |
  +--javax.management.relation.Role
All Implemented Interfaces:
java.io.Serializable

public class Role
extends java.lang.Object
implements java.io.Serializable

Represents a role: includes a role name and referenced MBeans (via their ObjectNames). The role value is always represented as an ArrayList collection (of ObjectNames) to homogenise the access.

See Also:
Serialized Form

Constructor Summary
Role(java.lang.String theRoleName, java.util.List theRoleValue)
          Constructor.
 
Method Summary
 java.lang.Object clone()
          Cloning.Creates a duplicate copy for the current Role object Overrides: clone in class java.lang.Object
 java.lang.String getRoleName()
          Retrieves role name
 java.util.List getRoleValue()
          Retrieves role value
static java.lang.String roleValueToString(java.util.List theRoleValue)
          Returns a string for the given role value
 void setRoleName(java.lang.String theRoleName)
          Sets role name
 void setRoleValue(java.util.List theRoleValue)
          Sets role value
 java.lang.String toString()
          Prints a string describing the role Overrides: toString in class java.lang.Object
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Role

public Role(java.lang.String theRoleName,
            java.util.List theRoleValue)
     throws java.lang.IllegalArgumentException
Constructor. No verification about the provided ObjectNames, no need for them to be registered at this level. This checking will be made when trying to set a relation role.
Parameters:
theRoleName - - role name
theRoleValue - - role value (ArrayList of ObjectName objects)
Throws:
java.lang.IllegalArgumentException - - if null parameter
Method Detail

clone

public java.lang.Object clone()
Cloning.Creates a duplicate copy for the current Role object Overrides: clone in class java.lang.Object
Overrides:
clone in class java.lang.Object
Returns:
a Role being an independent copy of the current Role object.

getRoleName

public java.lang.String getRoleName()
Retrieves role name
Returns:
This gets the name of role

getRoleValue

public java.util.List getRoleValue()
Retrieves role value
Returns:
ArrayList of ObjectName objects for referenced MBeans.

roleValueToString

public static java.lang.String roleValueToString(java.util.List theRoleValue)
                                          throws java.lang.IllegalArgumentException
Returns a string for the given role value
Parameters:
theRoleValue - - ArrayList of ObjectName objects
Returns:
String being the ObjectNames separated by commas.
Throws:
java.lang.IllegalArgumentException - - if null parameter

setRoleName

public void setRoleName(java.lang.String theRoleName)
                 throws java.lang.IllegalArgumentException
Sets role name
Parameters:
theRoleName - - role name
Throws:
java.lang.IllegalArgumentException - - if null parameter

setRoleValue

public void setRoleValue(java.util.List theRoleValue)
                  throws java.lang.IllegalArgumentException
Sets role value
Parameters:
theRoleValue - - ArrayList of ObjectName objects for referenced MBeans.
Throws:
java.lang.IllegalArgumentException - - if null parameter

toString

public java.lang.String toString()
Prints a string describing the role Overrides: toString in class java.lang.Object
Overrides:
toString in class java.lang.Object
Returns:
String format of the role

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.