- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<Object>
,Collection<Object>
,List<Object>
,RandomAccess
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.
- Since:
- 1.5
- See Also:
- Serialized Form
-
Field Summary
-
Constructor Summary
Constructors Constructor Description RoleList()
Constructs an empty RoleList.RoleList(int initialCapacity)
Constructs an empty RoleList with the initial capacity specified.RoleList(List<Role> list)
Constructs aRoleList
containing the elements of theList
specified, in the order in which they are returned by theList
's iterator. -
Method Summary
Modifier and Type Method Description void
add(int index, Role role)
Inserts the role specified as an element at the position specified.void
add(Role role)
Adds the Role specified as the last element of the list.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 aList<Role>
.void
set(int index, Role role)
Sets the element at the position specified to be the role specified.Methods declared in class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, retainAll, set, size, spliterator, subList, toArray, toArray, trimToSize
-
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 aRoleList
containing the elements of theList
specified, in the order in which they are returned by theList
's iterator. TheRoleList
instance has an initial capacity of 110% of the size of theList
specified.- Parameters:
list
- theList
that defines the initial contents of the newRoleList
.- Throws:
IllegalArgumentException
- if thelist
parameter isnull
or if thelist
parameter contains any non-Role objects.- See Also:
ArrayList(java.util.Collection)
-
-
Method Details
-
asList
Return a view of this list as aList<Role>
. Changes to the returned value are reflected by changes to the originalRoleList
and vice versa.- Returns:
- a
List<Role>
whose contents reflect the contents of thisRoleList
.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 aRole
will fail with anIllegalArgumentException
. For compatibility reasons, aRoleList
on which this method has never been called does allow objects other thanRole
s to be added. - Throws:
IllegalArgumentException
- if thisRoleList
contains 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:
ArrayList.addAll(Collection)
-
addAll
public boolean addAll(int index, RoleList roleList) throws IllegalArgumentException, IndexOutOfBoundsExceptionInserts 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)
-