javax.management.relation
Class Role

java.lang.Object
  |
  +--javax.management.relation.Role

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 homogeneise the access.

Version:

1.7

Author:

Maurizio Simeoni

See Also:

Serialized Form

Constructor Summary

Role(java.lang.String theRoleName, java.util.List theRoleValue)
Constructor

Method Summary

java.lang.Object	clone() Cloning.
java.lang.String	getRoleName() Retrieves role name
java.util.List	getRoleValue() Retrieves role value
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

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.

Throws:

java.lang.IllegalArgumentException - if null parameter

Method Detail

getRoleName

public java.lang.String getRoleName()

Retrieves role name

getRoleValue

public java.util.List getRoleValue()

Retrieves role value

Returns:

ArrayList of ObjectName objects for referenced MBeans.

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

clone

public java.lang.Object clone()

Cloning.

Overrides:

clone in class java.lang.Object

Returns:

a Role being an independent copy of the current Role object.

toString

public java.lang.String toString()

Prints a string describing the role

. The string representation consists of the name of the role and a list of the role value (ObjectName), enclosed in square brackets ("[]").

Overrides:

toString in class java.lang.Object

roleValueToString

public 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.