Role (Java Platform SE 6)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java™ Platform
Standard Ed. 6

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.relation
Class Role

java.lang.Object
 extended by javax.management.relation.Role

All Implemented Interfaces:: Serializable

public class Role
extends Object
implements Serializable
extends Object
implements 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 homogenize the access.

The serialVersionUID of this class is -279985518429862552L.

Since:: 1.5
See Also:: Serialized Form

Constructor Summary
`Role(String roleName, List<ObjectName> roleValue)` Make a new Role object.

Method Summary
`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.

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

Role

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

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

Method Detail

getRoleName

public String getRoleName()

Retrieves role name.

Returns:: the role name.
See Also:: setRoleName(java.lang.String)

getRoleValue

public List<ObjectName> getRoleValue()

Retrieves role value.

Returns:: ArrayList of ObjectName objects for referenced MBeans.
See Also:: setRoleValue(java.util.List)

setRoleName

public void setRoleName(String roleName)
 throws IllegalArgumentException

Sets role name.

Parameters:: roleName - role name
Throws:: IllegalArgumentException - if null parameter
See Also:: getRoleName()

setRoleValue

public void setRoleValue(List<ObjectName> roleValue)
 throws IllegalArgumentException

Sets role value.

Parameters:: roleValue - List of ObjectName objects for referenced MBeans.
Throws:: IllegalArgumentException - if null parameter
See Also:: getRoleValue()

toString

public String toString()

Returns a string describing the role.

Overrides:: toString in class Object

Returns:: the description of the role.

clone

public Object clone()

Clone the role object.

Overrides:: clone in class Object

Returns:: a Role that is an independent copy of the current Role object.
See Also:: Cloneable

roleValueToString

public static String roleValueToString(List<ObjectName> roleValue)
 throws IllegalArgumentException

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