Interface ReferenceList<K>
- All Superinterfaces:
Collection<K>,Iterable<K>,List<K>,it.unimi.dsi.fastutil.objects.ObjectIterable<K>,ReferenceCollection<K>,SequencedCollection<K>
- All Known Implementing Classes:
AbstractReferenceList,AbstractReferenceList.ReferenceRandomAccessSubList,AbstractReferenceList.ReferenceSubList,ReferenceArrayList,ReferenceArrayList.SubList,ReferenceImmutableList,ReferenceLists.EmptyList,ReferenceLists.Singleton,ReferenceLists.SynchronizedList,ReferenceLists.SynchronizedRandomAccessList,ReferenceLists.UnmodifiableList,ReferenceLists.UnmodifiableRandomAccessList
List; provides some additional methods that use polymorphism to avoid (un)boxing.
Additionally, this interface strengthens iterator(), listIterator(),
listIterator(int) and subList(int,int). The former had been already
strengthened upstream, but unfortunately List re-specifies it.
This interface specifies reference equality semantics (members will be compared equal with
== instead of equals), which may result in breaks in contract
if attempted to be used with non reference-equality semantics based Lists. For example, a
aReferenceList.equals(aObjectList) may return different a different result then
aObjectList.equals(aReferenceList), in violation of equals's contract
requiring it being symmetric.
Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault booleanaddAll(int index, ReferenceList<? extends K> l) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).default booleanaddAll(ReferenceList<? extends K> l) Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).voidaddElements(int index, K[] a) Add (hopefully quickly) elements to this type-specific list.voidaddElements(int index, K[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.voidgetElements(int from, Object[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.it.unimi.dsi.fastutil.objects.ObjectListIterator<K> iterator()Returns a type-specific iterator on the elements of this list.it.unimi.dsi.fastutil.objects.ObjectListIterator<K> Returns a type-specific list iterator on the list.it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.static <K> ReferenceList<K> of()Returns an immutable empty list.static <K> ReferenceList<K> of(K e) Returns an immutable list with the element given.static <K> ReferenceList<K> of(K... a) Returns an immutable list with the elements given.static <K> ReferenceList<K> of(K e0, K e1) Returns an immutable list with the elements given.static <K> ReferenceList<K> of(K e0, K e1, K e2) Returns an immutable list with the elements given.voidremoveElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.default voidsetElements(int index, K[] a) Set (hopefully quickly) elements to match the array given.default voidsetElements(int index, K[] a, int offset, int length) Set (hopefully quickly) elements to match the array given.default voidsetElements(K[] a) Set (hopefully quickly) elements to match the array given.voidsize(int size) Sets the size of this list.default voidsort(Comparator<? super K> comparator) Sorts this list using a sort assured to be stable.default it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> Returns a type-specific spliterator on the elements of this list.subList(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.default voidunstableSort(Comparator<? super K> comparator) Sorts this list using a sort not assured to be stable.Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.List
add, add, addAll, addAll, addFirst, addLast, clear, contains, containsAll, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, lastIndexOf, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, toArray, toArray
-
Method Details
-
iterator
it.unimi.dsi.fastutil.objects.ObjectListIterator<K> iterator()Returns a type-specific iterator on the elements of this list.- Specified by:
iteratorin interfaceCollection<K>- Specified by:
iteratorin interfaceIterable<K>- Specified by:
iteratorin interfaceList<K>- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.objects.ObjectIterable<K>- Specified by:
iteratorin interfaceReferenceCollection<K>- Returns:
- an iterator on the elements of this list.
-
spliterator
Returns a type-specific spliterator on the elements of this list.List spliterators must report at least
Spliterator.SIZEDandSpliterator.ORDERED.See
List.spliterator()for more documentation on the requirements of the returned spliterator.- Specified by:
spliteratorin interfaceCollection<K>- Specified by:
spliteratorin interfaceIterable<K>- Specified by:
spliteratorin interfaceList<K>- Specified by:
spliteratorin interfaceit.unimi.dsi.fastutil.objects.ObjectIterable<K>- Specified by:
spliteratorin interfaceReferenceCollection<K>- Returns:
- a type-specific spliterator on the elements of this collection.
- Since:
- 8.5.0
-
listIterator
it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator()Returns a type-specific list iterator on the list.- Specified by:
listIteratorin interfaceList<K>- See Also:
-
listIterator
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceList<K>- See Also:
-
subList
Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive. -
size
void size(int size) Sets the size of this list.If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/
null/false.- Parameters:
size- the new size.
-
getElements
Copies (hopefully quickly) elements of this type-specific list into the given array.- Parameters:
from- the start index (inclusive).a- the destination array.offset- the offset into the destination array where to store the first element copied.length- the number of elements to be copied.
-
removeElements
void removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.- Parameters:
from- the start index (inclusive).to- the end index (exclusive).
-
addElements
Add (hopefully quickly) elements to this type-specific list.- Parameters:
index- the index at which to add elements.a- the array containing the elements.
-
addElements
Add (hopefully quickly) elements to this type-specific list.- Parameters:
index- the index at which to add elements.a- the array containing the elements.offset- the offset of the first element to add.length- the number of elements to add.
-
setElements
Set (hopefully quickly) elements to match the array given.- Parameters:
a- the array containing the elements.- Since:
- 8.3.0
-
setElements
Set (hopefully quickly) elements to match the array given.- Parameters:
index- the index at which to start setting elements.a- the array containing the elements.- Since:
- 8.3.0
-
setElements
Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if byListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(a[offset + i++]); }However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.- Parameters:
index- the index at which to start setting elements.a- the array containing the elementsoffset- the offset of the first element to add.length- the number of elements to add.- Since:
- 8.3.0
-
addAll
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- See Also:
-
addAll
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- See Also:
-
of
Returns an immutable empty list.- Returns:
- an immutable empty list.
-
of
Returns an immutable list with the element given.- Parameters:
e- the element that the returned list will contain.- Returns:
- an immutable list containing
e.
-
of
Returns an immutable list with the elements given.- Parameters:
e0- the first element.e1- the second element.- Returns:
- an immutable list containing
e0ande1.
-
of
Returns an immutable list with the elements given.- Parameters:
e0- the first element.e1- the second element.e2- the third element.- Returns:
- an immutable list containing
e0,e1, ande2.
-
of
Returns an immutable list with the elements given.Note that this method does not perform a defensive copy.
- Parameters:
a- a list of elements that will be used to initialize the immutable list.- Returns:
- an immutable list containing the elements of
a.
-
sort
Sorts this list using a sort assured to be stable.Pass
nullto sort using natural ordering.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
-
unstableSort
Sorts this list using a sort not assured to be stable. This differs fromList.sort(java.util.Comparator)in that the results are not assured to be stable, but may be a bit faster.Pass
nullto sort using natural ordering.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Since:
- 8.3.0
-