Class BooleanImmutableList
- All Implemented Interfaces:
BooleanCollection
,BooleanIterable
,BooleanList
,BooleanStack
,Stack<Boolean>
,Serializable
,Cloneable
,Comparable<List<? extends Boolean>>
,Iterable<Boolean>
,Collection<Boolean>
,List<Boolean>
,RandomAccess
,SequencedCollection<Boolean>
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
ConstructorDescriptionBooleanImmutableList
(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 boolean
add
(boolean k) Deprecated.final void
add
(int index, boolean k) Deprecated.final void
Deprecated.final boolean
Deprecated.final boolean
addAll
(int index, BooleanCollection c) Deprecated.final boolean
addAll
(int index, BooleanList c) Deprecated.final boolean
addAll
(int index, Collection<? extends Boolean> c) Deprecated.final boolean
Deprecated.final boolean
Deprecated.final boolean
addAll
(Collection<? extends Boolean> c) Deprecated.final void
addElements
(int index, boolean[] a, int offset, int length) Deprecated.final void
clear()
Deprecated.clone()
int
Compares this immutable list to another immutable list.int
Compares this list to another object.boolean
Compares this type-specific immutable list to another one.boolean
void
forEach
(BooleanConsumer action) Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.boolean
getBoolean
(int index) Returns the element at the specified position in this list.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.int
indexOf
(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.boolean
isEmpty()
Checks whether the stack is empty.int
lastIndexOf
(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 BooleanImmutableList
of()
Returns an empty immutable list.static BooleanImmutableList
of
(boolean... init) Creates an immutable list using a list of elements.final boolean
rem
(boolean k) Deprecated.final Boolean
remove
(int index) Deprecated.final boolean
Deprecated.final boolean
Deprecated.final boolean
removeAll
(Collection<?> c) Deprecated.final boolean
removeBoolean
(int index) Deprecated.final void
removeElements
(int from, int to) Deprecated.final boolean
Deprecated.final boolean
Deprecated.final void
replaceAll
(UnaryOperator<Boolean> operator) Deprecated.final boolean
Deprecated.final boolean
retainAll
(Collection<?> c) Deprecated.final boolean
set
(int index, boolean k) Deprecated.final Boolean
Deprecated.final void
setElements
(int index, boolean[] a, int offset, int length) Deprecated.int
size()
final void
size
(int size) Deprecated.final void
sort
(BooleanComparator comp) Deprecated.final void
sort
(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 void
Deprecated.final void
unstableSort
(Comparator<? super Boolean> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanList
addElements, contains, hashCode, iterator, listIterator, peekBoolean, popBoolean, push, topBoolean, toString
Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
contains, containsAll, containsAll, toBooleanArray
Methods inherited from class java.util.AbstractCollection
toArray, toArray
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
addAll, contains, containsAll, rem, removeAll, removeIf, removeIf, retainAll, toBooleanArray
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanIterable
forEach
Methods 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, unstableSort
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanStack
peek, pop, push, top
Methods 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:BooleanList
Returns the element at the specified position in this list.- Specified by:
getBoolean
in interfaceBooleanList
- See Also:
-
indexOf
public int indexOf(boolean k) Description copied from interface:BooleanList
Returns 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:
indexOf
in interfaceBooleanList
- Overrides:
indexOf
in classAbstractBooleanList
- See Also:
-
lastIndexOf
public int lastIndexOf(boolean k) Description copied from interface:BooleanList
Returns 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:
lastIndexOf
in interfaceBooleanList
- Overrides:
lastIndexOf
in classAbstractBooleanList
- See Also:
-
size
public int size()- Specified by:
size
in interfaceCollection<Boolean>
- Specified by:
size
in interfaceList<Boolean>
- Specified by:
size
in classAbstractCollection<Boolean>
-
isEmpty
public boolean isEmpty()Description copied from interface:Stack
Checks 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:
getElements
in interfaceBooleanList
- Overrides:
getElements
in 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:AbstractBooleanList
Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.- Specified by:
forEach
in interfaceBooleanIterable
- Overrides:
forEach
in classAbstractBooleanList
- Parameters:
action
- the action to be performed for each element.- See Also:
-
toBooleanArray
public boolean[] toBooleanArray()Description copied from interface:BooleanCollection
Returns a primitive type array containing the items of this collection.- Specified by:
toBooleanArray
in interfaceBooleanCollection
- Overrides:
toBooleanArray
in classAbstractBooleanList
- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public boolean[] toArray(boolean[] a) Description copied from interface:BooleanCollection
Returns 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:
toArray
in interfaceBooleanCollection
- Overrides:
toArray
in 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:AbstractBooleanList
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfaceBooleanList
- Specified by:
listIterator
in interfaceList<Boolean>
- Overrides:
listIterator
in classAbstractBooleanList
- See Also:
-
spliterator
Description copied from interface:BooleanList
Returns a type-specific spliterator on the elements of this list.List spliterators must report at least
Spliterator.SIZED
andSpliterator.ORDERED
.See
List.spliterator()
for more documentation on the requirements of the returned spliterator.- Specified by:
spliterator
in interfaceBooleanCollection
- Specified by:
spliterator
in interfaceBooleanIterable
- Specified by:
spliterator
in interfaceBooleanList
- Specified by:
spliterator
in interfaceCollection<Boolean>
- Specified by:
spliterator
in interfaceIterable<Boolean>
- Specified by:
spliterator
in 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:
subList
in interfaceBooleanList
- Specified by:
subList
in interfaceList<Boolean>
- Overrides:
subList
in classAbstractBooleanList
- See Also:
- API Notes:
- The returned list will be immutable, but is currently not declared to return an instance
of
ImmutableList
due 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:
equals
in interfaceCollection<Boolean>
- Specified by:
equals
in interfaceList<Boolean>
- Overrides:
equals
in 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:AbstractBooleanList
Compares this list to another object. If the argument is aList
, this method performs a lexicographical comparison; otherwise, it throws aClassCastException
.- Specified by:
compareTo
in interfaceComparable<List<? extends Boolean>>
- Overrides:
compareTo
in 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:AbstractBooleanList
Inserts the specified element at the specified position in this list (optional operation).- Specified by:
add
in interfaceBooleanList
- Overrides:
add
in classAbstractBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractBooleanList
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceBooleanCollection
- Specified by:
add
in interfaceBooleanList
- Overrides:
add
in classAbstractBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractBooleanList
- Specified by:
addAll
in interfaceCollection<Boolean>
- Specified by:
addAll
in interfaceList<Boolean>
- Overrides:
addAll
in classAbstractBooleanList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractBooleanList
Adds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAll
in interfaceList<Boolean>
- Overrides:
addAll
in classAbstractBooleanList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeBoolean
Deprecated.Description copied from class:AbstractBooleanList
Removes the element at the specified position in this list (optional operation).- Specified by:
removeBoolean
in interfaceBooleanList
- Overrides:
removeBoolean
in classAbstractBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
rem
Deprecated.Description copied from class:AbstractBooleanList
Removes a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
rem
in interfaceBooleanCollection
- Overrides:
rem
in classAbstractBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeAll
Deprecated.Description copied from class:AbstractBooleanCollection
- Specified by:
removeAll
in interfaceCollection<Boolean>
- Specified by:
removeAll
in interfaceList<Boolean>
- Overrides:
removeAll
in classAbstractBooleanCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
retainAll
Deprecated.Description copied from class:AbstractBooleanCollection
- Specified by:
retainAll
in interfaceCollection<Boolean>
- Specified by:
retainAll
in interfaceList<Boolean>
- Overrides:
retainAll
in classAbstractBooleanCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:BooleanCollection
- Specified by:
removeIf
in interfaceBooleanCollection
- Specified by:
removeIf
in interfaceCollection<Boolean>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:BooleanCollection
Remove from this collection all elements which satisfy the given predicate.- Specified by:
removeIf
in interfaceBooleanCollection
- Parameters:
c
- a predicate which returnstrue
for elements to be removed.- Returns:
true
if any elements were removed.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:BooleanList
- Specified by:
replaceAll
in interfaceBooleanList
- Specified by:
replaceAll
in interfaceList<Boolean>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
add
Deprecated.Description copied from interface:BooleanList
- Specified by:
add
in interfaceBooleanList
- Specified by:
add
in interfaceList<Boolean>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractBooleanCollection
- Specified by:
add
in interfaceBooleanCollection
- Specified by:
add
in interfaceBooleanList
- Specified by:
add
in interfaceCollection<Boolean>
- Specified by:
add
in interfaceList<Boolean>
- Overrides:
add
in classAbstractBooleanCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
remove
Deprecated.Description copied from interface:BooleanList
- Specified by:
remove
in interfaceBooleanList
- Specified by:
remove
in interfaceList<Boolean>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
remove
Deprecated.Description copied from class:AbstractBooleanCollection
- Specified by:
remove
in interfaceBooleanCollection
- Specified by:
remove
in interfaceBooleanList
- Specified by:
remove
in interfaceCollection<Boolean>
- Specified by:
remove
in interfaceList<Boolean>
- Overrides:
remove
in classAbstractBooleanCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
set
Deprecated.Description copied from interface:BooleanList
- Specified by:
set
in interfaceBooleanList
- Specified by:
set
in interfaceList<Boolean>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractBooleanList
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceBooleanCollection
- Overrides:
addAll
in classAbstractBooleanList
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from interface:BooleanList
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- Specified by:
addAll
in interfaceBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from interface:BooleanList
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAll
in interfaceBooleanList
- Overrides:
addAll
in classAbstractBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from interface:BooleanList
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAll
in interfaceBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeAll
Deprecated.Description copied from interface:BooleanCollection
Remove from this collection all elements in the given type-specific collection.- Specified by:
removeAll
in interfaceBooleanCollection
- Overrides:
removeAll
in classAbstractBooleanCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
retainAll
Deprecated.Description copied from interface:BooleanCollection
Retains in this collection only elements from the given type-specific collection.- Specified by:
retainAll
in interfaceBooleanCollection
- Overrides:
retainAll
in classAbstractBooleanCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
set
Deprecated.Description copied from class:AbstractBooleanList
Replaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
set
in interfaceBooleanList
- Overrides:
set
in classAbstractBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractBooleanList
- Specified by:
clear
in interfaceCollection<Boolean>
- Specified by:
clear
in interfaceList<Boolean>
- Overrides:
clear
in classAbstractBooleanList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
size
Deprecated.Description copied from interface:BooleanList
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
.- Specified by:
size
in interfaceBooleanList
- Overrides:
size
in classAbstractBooleanList
- Parameters:
size
- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractBooleanList
Removes (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:
removeElements
in interfaceBooleanList
- Overrides:
removeElements
in classAbstractBooleanList
- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addElements
Deprecated.Description copied from class:AbstractBooleanList
Add (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:
addElements
in interfaceBooleanList
- Overrides:
addElements
in 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
UnsupportedOperationException
as this is an immutable type.
-
setElements
Deprecated.Description copied from interface:BooleanList
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.- Specified by:
setElements
in interfaceBooleanList
- Overrides:
setElements
in 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
UnsupportedOperationException
as this is an immutable type.
-
sort
Deprecated.Description copied from interface:BooleanList
Sort a list using a type-specific comparator.Pass
null
to sort using natural ordering.- Specified by:
sort
in interfaceBooleanList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:BooleanList
Sorts this list using a sort not assured to be stable.Pass
null
to 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:
unstableSort
in interfaceBooleanList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
sort
Deprecated.Description copied from interface:BooleanList
- Specified by:
sort
in interfaceBooleanList
- Specified by:
sort
in interfaceList<Boolean>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:BooleanList
Sorts this list using a sort not assured to be stable.- Specified by:
unstableSort
in interfaceBooleanList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-