public class

Role

extends Object
implements Serializable
java.lang.Object
   ↳ javax.management.relation.Role

Class Overview

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

The serialVersionUID of this class is -279985518429862552L.

Summary

Public Constructors
Role(String roleName, List<ObjectName> roleValue)

Make a new Role object.

Public Methods
Object clone()
Clone the role object.
String getRoleName()
Retrieves role name.
List<ObjectName> getRoleValue()
Retrieves role value.
static String roleValueToString(List<ObjectName> roleValue)
Returns a string for the given role value.
void setRoleName(String roleName)
Sets role name.
void setRoleValue(List<ObjectName> roleValue)
Sets role value.
String toString()
Returns a string describing the role.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Role (String roleName, List<ObjectName> roleValue)

Make a new Role object. No check is made that the ObjectNames in the role value exist in an MBean server. That check will be made when the role is set in a relation.

Parameters
roleName role name
roleValue role value (List of ObjectName objects)
Throws
IllegalArgumentException if null parameter

Public Methods

public Object clone ()

Clone the role object.

Returns
  • a Role that is an independent copy of the current Role object.

public String getRoleName ()

Retrieves role name.

Returns
  • the role name.
See Also

public List<ObjectName> getRoleValue ()

Retrieves role value.

Returns
  • ArrayList of ObjectName objects for referenced MBeans.
See Also

public static String roleValueToString (List<ObjectName> roleValue)

Returns a string for the given role value.

Parameters
roleValue List of ObjectName objects
Returns
  • A String consisting of the ObjectNames separated by newlines (\n).
Throws
IllegalArgumentException if null parameter

public void setRoleName (String roleName)

Sets role name.

Parameters
roleName role name
Throws
IllegalArgumentException if null parameter
See Also

public void setRoleValue (List<ObjectName> roleValue)

Sets role value.

Parameters
roleValue List of ObjectName objects for referenced MBeans.
Throws
IllegalArgumentException if null parameter
See Also

public String toString ()

Returns a string describing the role.

Returns
  • the description of the role.