- 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 SummaryConstructors Constructor Description RoleList()Constructs an empty RoleList.RoleList(int initialCapacity)Constructs an empty RoleList with the initial capacity specified.RoleList(List<Role> list)Constructs aRoleListcontaining the elements of theListspecified, in the order in which they are returned by theList's iterator.
- 
Method SummaryModifier and Type Method Description voidadd(int index, Role role)Inserts the role specified as an element at the position specified.voidadd(Role role)Adds the Role specified as the last element of the list.booleanaddAll(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.booleanaddAll(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>.voidset(int index, Role role)Sets the element at the position specified to be the role specified.Methods declared in class java.util.ArrayListadd, 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- 
RoleListpublic RoleList()Constructs an empty RoleList.
- 
RoleListpublic RoleList(int initialCapacity)Constructs an empty RoleList with the initial capacity specified.- Parameters:
- initialCapacity- initial capacity
 
- 
RoleListConstructs 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- the- Listthat defines the initial contents of the new- RoleList.
- Throws:
- IllegalArgumentException- if the- listparameter is- nullor if the- listparameter contains any non-Role objects.
- See Also:
- ArrayList(java.util.Collection)
 
 
- 
- 
Method Details- 
asListReturn 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 this- RoleListcontains an element that is not a- Role.
- Since:
- 1.6
 
- 
addAdds the Role specified as the last element of the list.- Parameters:
- role- the role to be added.
- Throws:
- IllegalArgumentException- if the role is null.
 
- 
addInserts 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.
 
- 
setSets 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.
 
- 
addAllAppends 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)
 
- 
addAllpublic 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)
 
 
-