Class RoleList

java.lang.Object
java.util.AbstractCollection<Object>
java.util.AbstractList<Object>
java.util.ArrayList<Object>
javax.management.relation.RoleList
All Implemented Interfaces:
Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, SequencedCollection<Object>
public class RoleList 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.

It is not permitted to add objects to a RoleList that are not instances of Role. This will produce an IllegalArgumentException when calling methods in this class, or when using listIterator and add or set.

Since:
1.5
See Also:

  • Constructor Details

    • 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:

  • Method Details

    • 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.
      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:

    • 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:

    • add

      public boolean add(Object o)
      Appends the specified element to the end of this list.
      Specified by:
      add in interface Collection<Object>
      Specified by:
      add in interface List<Object>
      Overrides:
      add in class ArrayList<Object>
      Parameters:
      o - element to be appended to this list
      Returns:
      true (as specified by Collection.add(E))
      Throws:
      IllegalArgumentException - if o is not a Role.

    • add

      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).
      Specified by:
      add in interface List<Object>
      Overrides:
      add in class ArrayList<Object>
      Parameters:
      index - index at which the specified element is to be inserted
      element - element to be inserted
      Throws:
      IllegalArgumentException - if element is not a Role.

    • addAll

      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.)
      Specified by:
      addAll in interface Collection<Object>
      Specified by:
      addAll in interface List<Object>
      Overrides:
      addAll in class ArrayList<Object>
      Parameters:
      c - collection containing elements to be added to this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      IllegalArgumentException - if c contains a member that is not a Role.
      See Also:

    • addAll

      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.
      Specified by:
      addAll in interface List<Object>
      Overrides:
      addAll in class ArrayList<Object>
      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
      Throws:
      IllegalArgumentException - if c contains a member that is not a Role.

    • set

      public Object set(int index, Object element)
      Replaces the element at the specified position in this list with the specified element.
      Specified by:
      set in interface List<Object>
      Overrides:
      set in class ArrayList<Object>
      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
      Throws:
      IllegalArgumentException - if element is not a Role.