Class IntImmutableList
- All Implemented Interfaces:
IntCollection,IntIterable,IntList,IntStack,Stack<Integer>,Serializable,Cloneable,Comparable<List<? extends Integer>>,Iterable<Integer>,Collection<Integer>,List<Integer>,RandomAccess,SequencedCollection<Integer>
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.ints.AbstractIntList
AbstractIntList.IntRandomAccessSubList, AbstractIntList.IntSubList -
Constructor Summary
ConstructorsConstructorDescriptionIntImmutableList(int[] a) Creates a new immutable list using a given array.IntImmutableList(int[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.Creates a new immutable list and fills it with a given type-specific collection.Creates a new immutable list and fills it with the elements returned by a type-specific iterator..Creates a new immutable list and fills it with a given type-specific list.IntImmutableList(Collection<? extends Integer> c) Creates a new immutable list and fills it with a given collection. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanadd(int k) Deprecated.final voidadd(int index, int k) Deprecated.final voidDeprecated.final booleanDeprecated.final booleanaddAll(int index, IntCollection c) Deprecated.final booleanDeprecated.final booleanaddAll(int index, Collection<? extends Integer> c) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanaddAll(Collection<? extends Integer> c) Deprecated.final voidaddElements(int index, int[] a, int offset, int length) Deprecated.final voidclear()Deprecated.clone()intCompares this immutable list to another immutable list.intCompares this list to another object.booleanCompares this type-specific immutable list to another one.booleanvoidforEach(IntConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.voidgetElements(int from, int[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.intgetInt(int index) Returns the element at the specified position in this list.intindexOf(int k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.booleanisEmpty()Checks whether the stack is empty.intlastIndexOf(int k) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.static IntImmutableListof()Returns an empty immutable list.static IntImmutableListof(int... init) Creates an immutable list using a list of elements.final booleanrem(int k) Deprecated.final Integerremove(int index) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanremoveAll(Collection<?> c) Deprecated.final voidremoveElements(int from, int to) Deprecated.final booleanDeprecated.final booleanDeprecated.final intremoveInt(int index) Deprecated.final voidreplaceAll(IntUnaryOperator operator) Deprecated.final voidreplaceAll(UnaryOperator<Integer> operator) Deprecated.final booleanDeprecated.final booleanretainAll(Collection<?> c) Deprecated.final intset(int index, int k) Deprecated.final IntegerDeprecated.final voidsetElements(int index, int[] a, int offset, int length) Deprecated.intsize()final voidsize(int size) Deprecated.final voidsort(IntComparator comp) Deprecated.final voidsort(Comparator<? super Integer> comparator) Deprecated.Returns a type-specific spliterator on the elements of this collection.subList(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.int[]toArray(int[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.int[]Returns a primitive type array containing the items of this collection.static IntImmutableListCollects the result of a primitiveStreaminto a new ImmutableList.static IntImmutableListtoListWithExpectedSize(IntStream stream, int expectedSize) Collects the result of a primitiveStreaminto a new ImmutableList, potentially pre-allocated to handle the given size.final voidunstableSort(IntComparator comp) Deprecated.final voidunstableSort(Comparator<? super Integer> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList
addElements, contains, hashCode, iterator, listIterator, peekInt, popInt, push, replaceAll, topInt, toStringMethods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
contains, containsAll, containsAll, forEach, removeIf, toIntArrayMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, rem, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toIntArrayMethods inherited from interface it.unimi.dsi.fastutil.ints.IntIterable
forEach, forEachMethods inherited from interface it.unimi.dsi.fastutil.ints.IntList
add, add, add, add, addAll, addAll, addAll, addElements, addElements, contains, get, indexOf, iterator, lastIndexOf, listIterator, remove, remove, removeElements, removeInt, replaceAll, replaceAll, replaceAll, set, set, setElements, setElements, setElements, size, sort, sort, unstableSort, unstableSort
-
Constructor Details
-
IntImmutableList
public IntImmutableList(int[] a) 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.
-
IntImmutableList
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.
-
IntImmutableList
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.
-
IntImmutableList
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.
-
IntImmutableList
public IntImmutableList(int[] a, int offset, int length) 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.
-
IntImmutableList
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
Collects the result of a primitiveStreaminto a new ImmutableList.This method performs a terminal operation on the given
Stream- API Notes:
- Taking a primitive stream instead of returning something like a
Collectoris necessary because there is no primitiveCollectorequivalent in the Java API.
-
toListWithExpectedSize
Collects the result of a primitiveStreaminto a new ImmutableList, potentially pre-allocated to handle the given size.This method performs a terminal operation on the given
Stream- API Notes:
- Taking a primitive stream instead returning something like a
Collectoris necessary because there is no primitiveCollectorequivalent in the Java API.
-
getInt
-
indexOf
public int indexOf(int k) Description copied from interface:IntListReturns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
indexOfin interfaceIntList- Overrides:
indexOfin classAbstractIntList- See Also:
-
lastIndexOf
public int lastIndexOf(int k) Description copied from interface:IntListReturns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOfin interfaceIntList- Overrides:
lastIndexOfin classAbstractIntList- See Also:
-
size
public int size()- Specified by:
sizein interfaceCollection<Integer>- Specified by:
sizein interfaceList<Integer>- Specified by:
sizein classAbstractCollection<Integer>
-
isEmpty
public boolean isEmpty()Description copied from interface:StackChecks whether the stack is empty. -
getElements
public void getElements(int from, int[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElementsin interfaceIntList- Overrides:
getElementsin classAbstractIntList- 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:AbstractIntListPerforms the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceIntIterable- Overrides:
forEachin classAbstractIntList- Parameters:
action- the action to be performed for each element.- See Also:
-
toIntArray
public int[] toIntArray()Description copied from interface:IntCollectionReturns a primitive type array containing the items of this collection.- Specified by:
toIntArrayin interfaceIntCollection- Overrides:
toIntArrayin classAbstractIntList- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public int[] toArray(int[] a) Description copied from interface:IntCollectionReturns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.Note that, contrarily to
Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.- Specified by:
toArrayin interfaceIntCollection- Overrides:
toArrayin classAbstractIntList- Parameters:
a- if this array is big enough, it will be used to store this collection.- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
listIterator
Description copied from class:AbstractIntListReturns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceIntList- Specified by:
listIteratorin interfaceList<Integer>- Overrides:
listIteratorin classAbstractIntList- See Also:
-
spliterator
Description copied from interface:IntCollectionReturns a type-specific spliterator on the elements of this collection.See
Collection.spliterator()for more documentation on the requirements of the returned spliterator.- Specified by:
spliteratorin interfaceCollection<Integer>- Specified by:
spliteratorin interfaceIntCollection- Specified by:
spliteratorin interfaceIntIterable- Specified by:
spliteratorin interfaceIntList- Specified by:
spliteratorin interfaceIterable<Integer>- Specified by:
spliteratorin interfaceList<Integer>- 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 interfaceIntList- Specified by:
subListin interfaceList<Integer>- Overrides:
subListin classAbstractIntList- 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<Integer>- Specified by:
equalsin interfaceList<Integer>- Overrides:
equalsin classAbstractIntList
-
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:AbstractIntListCompares this list to another object. If the argument is aList, this method performs a lexicographical comparison; otherwise, it throws aClassCastException.- Specified by:
compareToin interfaceComparable<List<? extends Integer>>- Overrides:
compareToin classAbstractIntList- 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:AbstractIntListInserts the specified element at the specified position in this list (optional operation).- Specified by:
addin interfaceIntList- Overrides:
addin classAbstractIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractIntListEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceIntCollection- Specified by:
addin interfaceIntList- Overrides:
addin classAbstractIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractIntList- Specified by:
addAllin interfaceCollection<Integer>- Specified by:
addAllin interfaceList<Integer>- Overrides:
addAllin classAbstractIntList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractIntListAdds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAllin interfaceList<Integer>- Overrides:
addAllin classAbstractIntList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeInt
Deprecated.Description copied from class:AbstractIntListRemoves the element at the specified position in this list (optional operation).- Specified by:
removeIntin interfaceIntList- Overrides:
removeIntin classAbstractIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
rem
Deprecated.Description copied from class:AbstractIntListRemoves a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
remin interfaceIntCollection- Overrides:
remin classAbstractIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from class:AbstractIntCollection- Specified by:
removeAllin interfaceCollection<Integer>- Specified by:
removeAllin interfaceList<Integer>- Overrides:
removeAllin classAbstractIntCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from class:AbstractIntCollection- Specified by:
retainAllin interfaceCollection<Integer>- Specified by:
retainAllin interfaceList<Integer>- Overrides:
retainAllin classAbstractIntCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:IntCollection- Specified by:
removeIfin interfaceCollection<Integer>- Specified by:
removeIfin interfaceIntCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:IntCollectionRemove from this collection all elements which satisfy the given predicate.- Specified by:
removeIfin interfaceIntCollection- Parameters:
c- a predicate which returnstruefor elements to be removed.- Returns:
trueif any elements were removed.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:IntList- Specified by:
replaceAllin interfaceIntList- Specified by:
replaceAllin interfaceList<Integer>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:IntListReplaces each element of this list with the result of applying the operator to that element.- Specified by:
replaceAllin interfaceIntList- Parameters:
operator- the operator to apply to each element.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from interface:IntList -
add
Deprecated.Description copied from class:AbstractIntCollection- Specified by:
addin interfaceCollection<Integer>- Specified by:
addin interfaceIntCollection- Specified by:
addin interfaceIntList- Specified by:
addin interfaceList<Integer>- Overrides:
addin classAbstractIntCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.Description copied from interface:IntList -
remove
Deprecated.Description copied from class:AbstractIntCollection- Specified by:
removein interfaceCollection<Integer>- Specified by:
removein interfaceIntCollection- Specified by:
removein interfaceIntList- Specified by:
removein interfaceList<Integer>- Overrides:
removein classAbstractIntCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from interface:IntList -
addAll
Deprecated.Description copied from class:AbstractIntListAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceIntCollection- Overrides:
addAllin classAbstractIntList- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:IntListAppends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- Specified by:
addAllin interfaceIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:IntListInserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceIntList- Overrides:
addAllin classAbstractIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:IntListInserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from interface:IntCollectionRemove from this collection all elements in the given type-specific collection.- Specified by:
removeAllin interfaceIntCollection- Overrides:
removeAllin classAbstractIntCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from interface:IntCollectionRetains in this collection only elements from the given type-specific collection.- Specified by:
retainAllin interfaceIntCollection- Overrides:
retainAllin classAbstractIntCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from class:AbstractIntListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceIntList- Overrides:
setin classAbstractIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractIntList- Specified by:
clearin interfaceCollection<Integer>- Specified by:
clearin interfaceList<Integer>- Overrides:
clearin classAbstractIntList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
size
Deprecated.Description copied from interface:IntListSets 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 interfaceIntList- Overrides:
sizein classAbstractIntList- Parameters:
size- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractIntListRemoves (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 interfaceIntList- Overrides:
removeElementsin classAbstractIntList- 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:AbstractIntListAdd (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 interfaceIntList- Overrides:
addElementsin classAbstractIntList- 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:IntListSet (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 interfaceIntList- Overrides:
setElementsin classAbstractIntList- 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:IntListSort a list using a type-specific comparator.Pass
nullto sort using natural ordering.- Specified by:
sortin interfaceIntList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:IntListSorts this list using a sort not assured to be stable.Pass
nullto sort using natural ordering.This differs from
List.sort(java.util.Comparator)in that the results are not assured to be stable, but may be a bit faster.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Specified by:
unstableSortin interfaceIntList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:IntList -
unstableSort
Deprecated.Description copied from interface:IntListSorts this list using a sort not assured to be stable.- Specified by:
unstableSortin interfaceIntList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-