public class

RoleList

extends ArrayList<E>
java.lang.Object
   ↳ java.util.AbstractCollection<E>
     ↳ java.util.AbstractList<E>
       ↳ java.util.ArrayList<E>
         ↳ javax.management.relation.RoleList

Class Overview

A RoleList represents a list of roles (Role objects). It is used as parameter when creating a relation, and when trying to set several roles in a relation (via 'setRoles()' method). It is returned as part of a RoleResult, to provide roles successfully retrieved.

Summary

[Expand]
Inherited Fields
From class java.util.AbstractList
Public Constructors
RoleList()
Constructs an empty RoleList.
RoleList(int initialCapacity)
Constructs an empty RoleList with the initial capacity specified.
RoleList(List<Role> list)
Constructs a RoleList containing the elements of the List specified, in the order in which they are returned by the List's iterator.
Public Methods
void add(int index, Role role)
Inserts the role specified as an element at the position specified.
void add(int index, Object element)
Inserts the specified element at the specified position in this list.
void add(Role role)
Adds the Role specified as the last element of the list.
boolean add(Object o)
Appends the specified element to the end of this list.
boolean addAll(int index, Collection<?> c)
Inserts all of the elements in the specified collection into this list, starting at the specified position.
boolean addAll(int index, RoleList roleList)
Inserts all of the elements in the RoleList specified into this list, starting at the specified position, in the order in which they are returned by the Iterator of the RoleList specified.
boolean addAll(RoleList roleList)
Appends all the elements in the RoleList specified to the end of the list, in the order in which they are returned by the Iterator of the RoleList specified.
boolean addAll(Collection<?> c)
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator.
List<Role> asList()
Return a view of this list as a List<Role>.
void set(int index, Role role)
Sets the element at the position specified to be the role specified.
Object set(int index, Object element)
Replaces the element at the specified position in this list with the specified element.
[Expand]
Inherited Methods
From class java.util.ArrayList
From class java.util.AbstractList
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface java.util.List

Public Constructors

public RoleList ()

Constructs an empty RoleList.

public RoleList (int initialCapacity)

Constructs an empty RoleList with the initial capacity specified.

Parameters
initialCapacity initial capacity

public RoleList (List<Role> list)

Constructs a RoleList containing the elements of the List specified, in the order in which they are returned by the List's iterator. The RoleList instance has an initial capacity of 110% of the size of the List specified.

Parameters
list the List that defines the initial contents of the new RoleList.
Throws
IllegalArgumentException if the list parameter is null or if the list parameter contains any non-Role objects.

Public Methods

public void add (int index, Role role)

Inserts the role specified as an element at the position specified. Elements with an index greater than or equal to the current position are shifted up.

Parameters
index The position in the list where the new Role object is to be inserted.
role The Role object to be inserted.
Throws
IllegalArgumentException if the role is null.
IndexOutOfBoundsException if accessing with an index outside of the list.

public void add (int index, Object element)

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters
index index at which the specified element is to be inserted
element element to be inserted

public void add (Role role)

Adds the Role specified as the last element of the list.

Parameters
role the role to be added.
Throws
IllegalArgumentException if the role is null.

public boolean add (Object o)

Appends the specified element to the end of this list.

Parameters
o element to be appended to this list
Returns
  • true (as specified by add(E))

public boolean addAll (int index, Collection<?> c)

Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Parameters
index index at which to insert the first element from the specified collection
c collection containing elements to be added to this list
Returns
  • true if this list changed as a result of the call

public boolean addAll (int index, RoleList roleList)

Inserts all of the elements in the RoleList specified into this list, starting at the specified position, in the order in which they are returned by the Iterator of the RoleList specified.

Parameters
index Position at which to insert the first element from the RoleList specified.
roleList Elements to be inserted into the list.
Returns
  • true if this list changed as a result of the call.
Throws
IllegalArgumentException if the role is null.
IndexOutOfBoundsException if accessing with an index outside of the list.

public boolean addAll (RoleList roleList)

Appends all the elements in the RoleList specified to the end of the list, in the order in which they are returned by the Iterator of the RoleList specified.

Parameters
roleList Elements to be inserted into the list (can be null)
Returns
  • true if this list changed as a result of the call.
Throws
IndexOutOfBoundsException if accessing with an index outside of the list.

public boolean addAll (Collection<?> c)

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this list, and this list is nonempty.)

Parameters
c collection containing elements to be added to this list
Returns
  • true if this list changed as a result of the call

public List<Role> asList ()

Return a view of this list as a List<Role>. Changes to the returned value are reflected by changes to the original RoleList and vice versa.

Returns
  • a List<Role> whose contents reflect the contents of this RoleList.

    If this method has ever been called on a given RoleList instance, a subsequent attempt to add an object to that instance which is not a Role will fail with an IllegalArgumentException. For compatibility reasons, a RoleList on which this method has never been called does allow objects other than Roles to be added.

Throws
IllegalArgumentException if this RoleList contains an element that is not a Role.

public void set (int index, Role role)

Sets the element at the position specified to be the role specified. The previous element at that position is discarded.

Parameters
index The position specified.
role The value to which the role element should be set.
Throws
IllegalArgumentException if the role is null.
IndexOutOfBoundsException if accessing with an index outside of the list.

public Object set (int index, Object element)

Replaces the element at the specified position in this list with the specified element.

Parameters
index index of the element to replace
element element to be stored at the specified position
Returns
  • the element previously at the specified position