JavaDoc Documentation Repository

javax.management.relation
Class RoleList

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

All Implemented Interfaces:: Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess

public class RoleList
extends ArrayList<Object>
extends ArrayList<Object>

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.

Since:: 1.5
See Also:: Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList
`modCount`

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

Method Summary
`void`	`add(int index, Object element)` Inserts the specified element at the specified position in this list.
`void`	`add(int index, Role role)` Inserts the role specified as an element at the position specified.
`boolean`	`add(Object o)` Appends the specified element to the end of this list.
`void`	`add(Role role)` Adds the Role specified as the last element of the list.
`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.
`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.
`List<Role>`	`asList()` Return a view of this list as a `List<Role>`.
`Object`	`set(int index, Object element)` Replaces the element at the specified position in this list with the specified element.
`void`	`set(int index, Role role)` Sets the element at the position specified to be the role specified.

Methods inherited from class java.util.ArrayList
`clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, size, toArray, toArray, trimToSize`

Methods inherited from class java.util.AbstractList
`equals, hashCode, iterator, listIterator, listIterator, subList`

Methods inherited from class java.util.AbstractCollection
`containsAll, removeAll, retainAll, toString`

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

Methods inherited from interface java.util.List
`containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList`

Constructor Detail

RoleList

public RoleList()

Constructs an empty RoleList.

RoleList

public RoleList(int initialCapacity)

Constructs an empty RoleList with the initial capacity specified.

Parameters:: initialCapacity - initial capacity

RoleList

public RoleList(List<Role> list)
         throws IllegalArgumentException

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.
See Also:: ArrayList.ArrayList(java.util.Collection)

Method Detail

asList

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.
Since:: 1.6

add

public void add(Role role)
         throws IllegalArgumentException

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.

add

public void add(int index,
                Role role)
         throws IllegalArgumentException,
                IndexOutOfBoundsException

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.

set

public void set(int index,
                Role role)
         throws IllegalArgumentException,
                IndexOutOfBoundsException

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.

addAll

public boolean addAll(RoleList roleList)
               throws IndexOutOfBoundsException

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.
See Also:: ArrayList.addAll(Collection)

addAll

public boolean addAll(int index,
                      RoleList roleList)
               throws IllegalArgumentException,
                      IndexOutOfBoundsException

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.
See Also:: ArrayList.addAll(int, Collection)