Class ObjectImmutableList<K>
- All Implemented Interfaces:
ObjectCollection<K>,ObjectIterable<K>,ObjectList<K>,Stack<K>,Serializable,Cloneable,Comparable<List<? extends K>>,Iterable<K>,Collection<K>,List<K>,RandomAccess
Instances of this class are immutable and (contrarily to mutable array-based list implementations) the backing array is not exposed. Instances can be built using a variety of methods, but note that constructors using an array will not make a defensive copy.
This class implements the bulk method getElements() using high-performance system calls
(e.g., System.arraycopy()) instead of
expensive loops.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectList
AbstractObjectList.ObjectRandomAccessSubList<K>, AbstractObjectList.ObjectSubList<K> -
Constructor Summary
ConstructorsConstructorDescriptionObjectImmutableList(ObjectCollection<? extends K> c) Creates a new immutable list and fills it with a given type-specific collection.ObjectImmutableList(ObjectIterator<? extends K> i) Creates a new immutable list and fills it with the elements returned by a type-specific iterator..ObjectImmutableList(ObjectList<? extends K> l) Creates a new immutable list and fills it with a given type-specific list.ObjectImmutableList(Collection<? extends K> c) Creates a new immutable list and fills it with a given collection.ObjectImmutableList(K[] a) Creates a new immutable list using a given array.ObjectImmutableList(K[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array. -
Method Summary
Modifier and TypeMethodDescriptionfinal voidDeprecated.final booleanDeprecated.final booleanaddAll(int index, Collection<? extends K> c) Deprecated.final booleanaddAll(Collection<? extends K> c) Deprecated.final voidaddElements(int index, K[] a, int offset, int length) Deprecated.final voidclear()Deprecated.clone()intcompareTo(ObjectImmutableList<? extends K> l) Compares this immutable list to another immutable list.intCompares this list to another object.booleanCompares this type-specific immutable list to another one.booleanvoidget(int index) voidgetElements(int from, Object[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.intbooleanisEmpty()Checks whether the stack is empty.intlistIterator(int index) Returns a type-specific list iterator on the list starting at a given index.static <K> ObjectImmutableList<K>of()Returns an empty immutable list.static <K> ObjectImmutableList<K>of(K... init) Creates an immutable list using a list of elements.final Kremove(int index) Deprecated.final booleanDeprecated.final booleanremoveAll(Collection<?> c) Deprecated.final voidremoveElements(int from, int to) Deprecated.final booleanDeprecated.final voidreplaceAll(UnaryOperator<K> operator) Deprecated.final booleanretainAll(Collection<?> c) Deprecated.final KDeprecated.final voidsetElements(int index, K[] a, int offset, int length) Deprecated.intsize()final voidsize(int size) Deprecated.final voidsort(Comparator<? super K> comparator) Deprecated.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.Object[]toArray()<T> T[]toArray(T[] a) static <K> Collector<K,?, ObjectImmutableList<K>> toList()Returns aCollectorthat collects aStream's elements into a new ImmutableList.static <K> Collector<K,?, ObjectImmutableList<K>> toListWithExpectedSize(int expectedSize) Returns aCollectorthat collects aStream's elements into a new ImmutableList, potentially pre-allocated to handle the given size.final voidunstableSort(Comparator<? super K> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectList
addElements, contains, hashCode, iterator, listIterator, peek, pop, push, top, toStringMethods inherited from class java.util.AbstractCollection
containsAllMethods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, hashCode, remove, remove, removeAll, replaceAll, retainAll, setMethods inherited from interface it.unimi.dsi.fastutil.objects.ObjectList
addAll, addAll, addElements, addElements, iterator, listIterator, removeElements, setElements, setElements, setElements, size, sort, unstableSort
-
Constructor Details
-
ObjectImmutableList
Creates a new immutable list using a given array.Note that this constructor does not perform a defensive copy.
- Parameters:
a- the array that will be used to back this immutable list.
-
ObjectImmutableList
Creates a new immutable list and fills it with a given collection.- Parameters:
c- a collection that will be used to fill the immutable list.
-
ObjectImmutableList
Creates a new immutable list and fills it with a given type-specific collection.- Parameters:
c- a type-specific collection that will be used to fill the immutable list.
-
ObjectImmutableList
Creates a new immutable list and fills it with a given type-specific list.- Parameters:
l- a type-specific list that will be used to fill the immutable list.
-
ObjectImmutableList
Creates a new immutable list and fills it with the elements of a given array.- Parameters:
a- an array whose elements will be used to fill the immutable list.offset- the first element to use.length- the number of elements to use.
-
ObjectImmutableList
Creates a new immutable list and fills it with the elements returned by a type-specific iterator..- Parameters:
i- a type-specific iterator whose returned elements will fill the immutable list.
-
-
Method Details
-
of
Returns an empty immutable list.- Returns:
- an immutable list (possibly shared) that is empty.
-
of
Creates an immutable list using a list of elements.Note that this method does not perform a defensive copy.
- Parameters:
init- a list of elements that will be used to initialize the list.- Returns:
- a new immutable list containing the given elements.
-
toList
Returns aCollectorthat collects aStream's elements into a new ImmutableList. -
toListWithExpectedSize
Returns aCollectorthat collects aStream's elements into a new ImmutableList, potentially pre-allocated to handle the given size. -
get
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceList<K>- Overrides:
lastIndexOfin classAbstractObjectList<K>
-
size
public int size()- Specified by:
sizein interfaceCollection<K>- Specified by:
sizein interfaceList<K>- Specified by:
sizein classAbstractCollection<K>
-
isEmpty
public boolean isEmpty()Description copied from interface:StackChecks whether the stack is empty. -
getElements
Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElementsin interfaceObjectList<K>- Overrides:
getElementsin classAbstractObjectList<K>- 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.
-
forEach
Description copied from class:AbstractObjectList -
toArray
- Specified by:
toArrayin interfaceCollection<K>- Specified by:
toArrayin interfaceList<K>- Overrides:
toArrayin classAbstractObjectList<K>
-
toArray
public <T> T[] toArray(T[] a) - Specified by:
toArrayin interfaceCollection<K>- Specified by:
toArrayin interfaceList<K>- Overrides:
toArrayin classAbstractObjectList<K>
-
listIterator
Description copied from class:AbstractObjectListReturns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceList<K>- Specified by:
listIteratorin interfaceObjectList<K>- Overrides:
listIteratorin classAbstractObjectList<K>- See Also:
-
spliterator
Description copied from interface:ObjectListReturns 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 interfaceObjectCollection<K>- Specified by:
spliteratorin interfaceObjectIterable<K>- Specified by:
spliteratorin interfaceObjectList<K>- Returns:
- a type-specific spliterator on the elements of this collection.
-
subList
Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.- Specified by:
subListin interfaceList<K>- Specified by:
subListin interfaceObjectList<K>- Overrides:
subListin classAbstractObjectList<K>- See Also:
- API Notes:
- The returned list will be immutable, but is currently not declared to return an instance
of
ImmutableListdue to complications of implementation details. This may change in a future version (in other words, do not consider the return type of this method to be stable if making a subclass ofImmutableList).
-
clone
-
equals
Compares this type-specific immutable list to another one.- Parameters:
l- a type-specific immutable list.- Returns:
- true if the argument contains the same elements of this type-specific immutable list.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
equals
- Specified by:
equalsin interfaceCollection<K>- Specified by:
equalsin interfaceList<K>- Overrides:
equalsin classAbstractObjectList<K>
-
compareTo
Compares this immutable list to another immutable list.- Parameters:
l- an immutable list.- Returns:
- a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
compareTo
Description copied from class:AbstractObjectListCompares this list to another object. If the argument is aList, this method performs a lexicographical comparison; otherwise, it throws aClassCastException.- Specified by:
compareToin interfaceComparable<K>- Overrides:
compareToin classAbstractObjectList<K>- Parameters:
l- a list.- Returns:
- if the argument is a
List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
-
add
Deprecated.Description copied from class:AbstractObjectList- Specified by:
addin interfaceList<K>- Overrides:
addin classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractObjectList- Specified by:
addin interfaceCollection<K>- Specified by:
addin interfaceList<K>- Overrides:
addin classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractObjectList- Specified by:
addAllin interfaceCollection<K>- Specified by:
addAllin interfaceList<K>- Overrides:
addAllin classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractObjectListAdds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAllin interfaceList<K>- Overrides:
addAllin classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.Description copied from class:AbstractObjectList- Specified by:
removein interfaceList<K>- Overrides:
removein classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.- Specified by:
removein interfaceCollection<K>- Specified by:
removein interfaceList<K>- Overrides:
removein classAbstractCollection<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.- Specified by:
removeAllin interfaceCollection<K>- Specified by:
removeAllin interfaceList<K>- Overrides:
removeAllin classAbstractCollection<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.- Specified by:
retainAllin interfaceCollection<K>- Specified by:
retainAllin interfaceList<K>- Overrides:
retainAllin classAbstractCollection<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.- Specified by:
removeIfin interfaceCollection<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.- Specified by:
replaceAllin interfaceList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from class:AbstractObjectList- Specified by:
setin interfaceList<K>- Overrides:
setin classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractObjectList- Specified by:
clearin interfaceCollection<K>- Specified by:
clearin interfaceList<K>- Overrides:
clearin classAbstractObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
size
Deprecated.Description copied from interface:ObjectListSets 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.- Specified by:
sizein interfaceObjectList<K>- Overrides:
sizein classAbstractObjectList<K>- Parameters:
size- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractObjectListRemoves (hopefully quickly) elements of this type-specific list.This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
removeElementsin interfaceObjectList<K>- Overrides:
removeElementsin classAbstractObjectList<K>- Parameters:
from- the start index (inclusive).to- the end index (exclusive).- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addElements
Deprecated.Description copied from class:AbstractObjectListAdd (hopefully quickly) elements to this type-specific list.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
addElementsin interfaceObjectList<K>- Overrides:
addElementsin classAbstractObjectList<K>- 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.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
setElements
Deprecated.Description copied from interface:ObjectListSet (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.- Specified by:
setElementsin interfaceObjectList<K>- Overrides:
setElementsin classAbstractObjectList<K>- 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.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:ObjectListSorts 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.
- Specified by:
sortin interfaceList<K>- Specified by:
sortin interfaceObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:ObjectListSorts 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.
- Specified by:
unstableSortin interfaceObjectList<K>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-