Class BooleanImmutableList
- All Implemented Interfaces:
BooleanCollection,BooleanIterable,BooleanList,BooleanStack,Stack<Boolean>,Serializable,Cloneable,Comparable<List<? extends Boolean>>,Iterable<Boolean>,Collection<Boolean>,List<Boolean>,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.booleans.AbstractBooleanList
AbstractBooleanList.BooleanRandomAccessSubList, AbstractBooleanList.BooleanSubList -
Constructor Summary
ConstructorsConstructorDescriptionBooleanImmutableList(boolean[] a) Creates a new immutable list using a given array.BooleanImmutableList(boolean[] 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.BooleanImmutableList(Collection<? extends Boolean> c) Creates a new immutable list and fills it with a given collection. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanadd(boolean k) Deprecated.final voidadd(int index, boolean k) Deprecated.final voidDeprecated.final booleanDeprecated.final booleanaddAll(int index, BooleanCollection c) Deprecated.final booleanaddAll(int index, BooleanList c) Deprecated.final booleanaddAll(int index, Collection<? extends Boolean> c) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanaddAll(Collection<? extends Boolean> c) Deprecated.final voidaddElements(int index, boolean[] 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(BooleanConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.booleangetBoolean(int index) Returns the element at the specified position in this list.voidgetElements(int from, boolean[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.intindexOf(boolean 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(boolean 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 BooleanImmutableListof()Returns an empty immutable list.static BooleanImmutableListof(boolean... init) Creates an immutable list using a list of elements.final booleanrem(boolean k) Deprecated.final Booleanremove(int index) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanremoveAll(Collection<?> c) Deprecated.final booleanremoveBoolean(int index) Deprecated.final voidremoveElements(int from, int to) Deprecated.final booleanDeprecated.final booleanDeprecated.final voidreplaceAll(UnaryOperator<Boolean> operator) Deprecated.final booleanDeprecated.final booleanretainAll(Collection<?> c) Deprecated.final booleanset(int index, boolean k) Deprecated.final BooleanDeprecated.final voidsetElements(int index, boolean[] a, int offset, int length) Deprecated.intsize()final voidsize(int size) Deprecated.final voidsort(BooleanComparator comp) Deprecated.final voidsort(Comparator<? super Boolean> 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.boolean[]toArray(boolean[] 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.boolean[]Returns a primitive type array containing the items of this collection.final voidDeprecated.final voidunstableSort(Comparator<? super Boolean> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanList
addElements, contains, hashCode, iterator, listIterator, peekBoolean, popBoolean, push, topBoolean, toStringMethods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
contains, containsAll, containsAll, toBooleanArrayMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
addAll, contains, containsAll, rem, removeAll, removeIf, removeIf, retainAll, toBooleanArrayMethods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanIterable
forEachMethods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanList
add, add, add, add, addAll, addAll, addAll, addElements, addElements, contains, get, indexOf, iterator, lastIndexOf, listIterator, remove, remove, removeBoolean, removeElements, replaceAll, replaceAll, set, set, setElements, setElements, setElements, size, sort, sort, unstableSort, unstableSortMethods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanStack
peek, pop, push, topMethods inherited from interface java.util.Collection
parallelStream, stream, toArray
-
Constructor Details
-
BooleanImmutableList
public BooleanImmutableList(boolean[] 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.
-
BooleanImmutableList
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.
-
BooleanImmutableList
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.
-
BooleanImmutableList
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.
-
BooleanImmutableList
public BooleanImmutableList(boolean[] 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.
-
BooleanImmutableList
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.
-
getBoolean
public boolean getBoolean(int index) Description copied from interface:BooleanListReturns the element at the specified position in this list.- Specified by:
getBooleanin interfaceBooleanList- See Also:
-
indexOf
public int indexOf(boolean k) Description copied from interface:BooleanListReturns 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 interfaceBooleanList- Overrides:
indexOfin classAbstractBooleanList- See Also:
-
lastIndexOf
public int lastIndexOf(boolean k) Description copied from interface:BooleanListReturns 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 interfaceBooleanList- Overrides:
lastIndexOfin classAbstractBooleanList- See Also:
-
size
public int size()- Specified by:
sizein interfaceCollection<Boolean>- Specified by:
sizein interfaceList<Boolean>- Specified by:
sizein classAbstractCollection<Boolean>
-
isEmpty
public boolean isEmpty()Description copied from interface:StackChecks whether the stack is empty. -
getElements
public void getElements(int from, boolean[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElementsin interfaceBooleanList- Overrides:
getElementsin classAbstractBooleanList- 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:AbstractBooleanListPerforms the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceBooleanIterable- Overrides:
forEachin classAbstractBooleanList- Parameters:
action- the action to be performed for each element.- See Also:
-
toBooleanArray
public boolean[] toBooleanArray()Description copied from interface:BooleanCollectionReturns a primitive type array containing the items of this collection.- Specified by:
toBooleanArrayin interfaceBooleanCollection- Overrides:
toBooleanArrayin classAbstractBooleanList- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public boolean[] toArray(boolean[] a) Description copied from interface:BooleanCollectionReturns 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 interfaceBooleanCollection- Overrides:
toArrayin classAbstractBooleanList- 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:AbstractBooleanListReturns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceBooleanList- Specified by:
listIteratorin interfaceList<Boolean>- Overrides:
listIteratorin classAbstractBooleanList- See Also:
-
spliterator
Description copied from interface:BooleanListReturns 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 interfaceBooleanCollection- Specified by:
spliteratorin interfaceBooleanIterable- Specified by:
spliteratorin interfaceBooleanList- Specified by:
spliteratorin interfaceCollection<Boolean>- Specified by:
spliteratorin interfaceIterable<Boolean>- Specified by:
spliteratorin interfaceList<Boolean>- 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 interfaceBooleanList- Specified by:
subListin interfaceList<Boolean>- Overrides:
subListin classAbstractBooleanList- 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<Boolean>- Specified by:
equalsin interfaceList<Boolean>- Overrides:
equalsin classAbstractBooleanList
-
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:AbstractBooleanListCompares 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 Boolean>>- Overrides:
compareToin classAbstractBooleanList- 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:AbstractBooleanListInserts the specified element at the specified position in this list (optional operation).- Specified by:
addin interfaceBooleanList- Overrides:
addin classAbstractBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractBooleanListEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceBooleanCollection- Specified by:
addin interfaceBooleanList- Overrides:
addin classAbstractBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractBooleanList- Specified by:
addAllin interfaceCollection<Boolean>- Specified by:
addAllin interfaceList<Boolean>- Overrides:
addAllin classAbstractBooleanList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractBooleanListAdds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAllin interfaceList<Boolean>- Overrides:
addAllin classAbstractBooleanList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeBoolean
Deprecated.Description copied from class:AbstractBooleanListRemoves the element at the specified position in this list (optional operation).- Specified by:
removeBooleanin interfaceBooleanList- Overrides:
removeBooleanin classAbstractBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
rem
Deprecated.Description copied from class:AbstractBooleanListRemoves a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
remin interfaceBooleanCollection- Overrides:
remin classAbstractBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from class:AbstractBooleanCollection- Specified by:
removeAllin interfaceCollection<Boolean>- Specified by:
removeAllin interfaceList<Boolean>- Overrides:
removeAllin classAbstractBooleanCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from class:AbstractBooleanCollection- Specified by:
retainAllin interfaceCollection<Boolean>- Specified by:
retainAllin interfaceList<Boolean>- Overrides:
retainAllin classAbstractBooleanCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:BooleanCollection- Specified by:
removeIfin interfaceBooleanCollection- Specified by:
removeIfin interfaceCollection<Boolean>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:BooleanCollectionRemove from this collection all elements which satisfy the given predicate.- Specified by:
removeIfin interfaceBooleanCollection- 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:BooleanList- Specified by:
replaceAllin interfaceBooleanList- Specified by:
replaceAllin interfaceList<Boolean>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from interface:BooleanList- Specified by:
addin interfaceBooleanList- Specified by:
addin interfaceList<Boolean>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractBooleanCollection- Specified by:
addin interfaceBooleanCollection- Specified by:
addin interfaceBooleanList- Specified by:
addin interfaceCollection<Boolean>- Specified by:
addin interfaceList<Boolean>- Overrides:
addin classAbstractBooleanCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.Description copied from interface:BooleanList- Specified by:
removein interfaceBooleanList- Specified by:
removein interfaceList<Boolean>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.Description copied from class:AbstractBooleanCollection- Specified by:
removein interfaceBooleanCollection- Specified by:
removein interfaceBooleanList- Specified by:
removein interfaceCollection<Boolean>- Specified by:
removein interfaceList<Boolean>- Overrides:
removein classAbstractBooleanCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from interface:BooleanList- Specified by:
setin interfaceBooleanList- Specified by:
setin interfaceList<Boolean>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractBooleanListAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceBooleanCollection- Overrides:
addAllin classAbstractBooleanList- 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:BooleanListAppends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- Specified by:
addAllin interfaceBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:BooleanListInserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceBooleanList- Overrides:
addAllin classAbstractBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:BooleanListInserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from interface:BooleanCollectionRemove from this collection all elements in the given type-specific collection.- Specified by:
removeAllin interfaceBooleanCollection- Overrides:
removeAllin classAbstractBooleanCollection- 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:BooleanCollectionRetains in this collection only elements from the given type-specific collection.- Specified by:
retainAllin interfaceBooleanCollection- Overrides:
retainAllin classAbstractBooleanCollection- 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:AbstractBooleanListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceBooleanList- Overrides:
setin classAbstractBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractBooleanList- Specified by:
clearin interfaceCollection<Boolean>- Specified by:
clearin interfaceList<Boolean>- Overrides:
clearin classAbstractBooleanList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
size
Deprecated.Description copied from interface:BooleanListSets 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 interfaceBooleanList- Overrides:
sizein classAbstractBooleanList- Parameters:
size- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractBooleanListRemoves (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 interfaceBooleanList- Overrides:
removeElementsin classAbstractBooleanList- 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:AbstractBooleanListAdd (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 interfaceBooleanList- Overrides:
addElementsin classAbstractBooleanList- 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:BooleanListSet (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 interfaceBooleanList- Overrides:
setElementsin classAbstractBooleanList- 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:BooleanListSort a list using a type-specific comparator.Pass
nullto sort using natural ordering.- Specified by:
sortin interfaceBooleanList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:BooleanListSorts 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 interfaceBooleanList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:BooleanList- Specified by:
sortin interfaceBooleanList- Specified by:
sortin interfaceList<Boolean>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:BooleanListSorts this list using a sort not assured to be stable.- Specified by:
unstableSortin interfaceBooleanList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-