Class RoleList
- All Implemented Interfaces:
Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, SequencedCollection<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:
-
Field Summary
Fields inherited from class AbstractList
modCount -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidInserts the specified element at the specified position in this list.voidInserts the role specified as an element at the position specified.booleanAppends the specified element to the end of this list.voidAdds the Role specified as the last element of the list.booleanaddAll(int index, Collection<?> c) Inserts all of the elements in the specified collection into this list, starting at the specified position.booleanInserts 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.booleanaddAll(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.booleanAppends 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.asList()Return a view of this list as aList<Role>.Replaces the element at the specified position in this list with the specified element.voidSets the element at the position specified to be the role specified.Methods inherited from class ArrayList
addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray, trimToSizeMethods inherited from class AbstractCollection
containsAll, toStringMethods inherited from interface Collection
parallelStream, stream, toArrayMethods inherited from interface List
containsAll, reversed
-
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
Constructs aRoleListcontaining the elements of theListspecified, in the order in which they are returned by theList's iterator. TheRoleListinstance has an initial capacity of 110% of the size of theListspecified.- Parameters:
list- theListthat defines the initial contents of the newRoleList.- Throws:
IllegalArgumentException- if thelistparameter isnullor if thelistparameter contains any non-Role objects.- See Also:
-
-
Method Details
-
asList
Return a view of this list as aList<Role>. Changes to the returned value are reflected by changes to the originalRoleListand vice versa.- Returns:
- a
List<Role>whose contents reflect the contents of thisRoleList.If this method has ever been called on a given
RoleListinstance, a subsequent attempt to add an object to that instance which is not aRolewill fail with anIllegalArgumentException. For compatibility reasons, aRoleListon which this method has never been called does allow objects other thanRoles to be added. - Throws:
IllegalArgumentException- if thisRoleListcontains an element that is not aRole.- Since:
- 1.6
-
add
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
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
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
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
Description copied from class:ArrayListAppends the specified element to the end of this list.- Specified by:
addin interfaceCollection<Object>- Specified by:
addin interfaceList<Object>- Overrides:
addin classArrayList<Object>- Parameters:
o- element to be appended to this list- Returns:
true(as specified byCollection.add(E))
-
add
Description copied from class:ArrayListInserts 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). -
addAll
Description copied from class:ArrayListAppends 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.) -
addAll
Description copied from class:ArrayListInserts 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:
addAllin interfaceList<Object>- Overrides:
addAllin classArrayList<Object>- Parameters:
index- index at which to insert the first element from the specified collectionc- collection containing elements to be added to this list- Returns:
trueif this list changed as a result of the call
-
set
Description copied from class:ArrayListReplaces the element at the specified position in this list with the specified element.
-