Role (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.relation
Class Role

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

All Implemented Interfaces:: Serializable

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

See Also:: Serialized Form

Constructor Summary

Role(String theRoleName, List theRoleValue)
          Make a new Role object.

Method Summary

Object clone()
          Clone the role object.

String getRoleName()
          Retrieves role name.

List getRoleValue()
          Retrieves role value.

static String roleValueToString(List theRoleValue)
          Returns a string for the given role value.

void setRoleName(String theRoleName)
          Sets role name.

void setRoleValue(List theRoleValue)
          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 theRoleName,
            List theRoleValue)
     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:

theRoleName - role name

theRoleValue - role value (ArrayList 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 getRoleValue()

Retrieves role value.

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

setRoleName

public void setRoleName(String theRoleName)
                 throws IllegalArgumentException

Sets role name.

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

setRoleValue

public void setRoleValue(List theRoleValue)
                  throws IllegalArgumentException

Sets role value.

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

toString

public String toString()

Returns a string describing the role.

Returns:: the description of the role.

clone

public Object clone()

Clone the role object.

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

roleValueToString

public static String roleValueToString(List theRoleValue)
                                throws IllegalArgumentException

Returns a string for the given role value.

Parameters:: theRoleValue - ArrayList of ObjectName objects
Returns:: A String consisting of the ObjectNames separated by newlines (\n).
Throws:: IllegalArgumentException - if null parameter