Interface BooleanList
-
- All Superinterfaces:
BooleanCollection
,BooleanIterable
,java.util.Collection<java.lang.Boolean>
,java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>
,java.lang.Iterable<java.lang.Boolean>
,java.util.List<java.lang.Boolean>
- All Known Implementing Classes:
AbstractBooleanList
,AbstractBooleanList.BooleanRandomAccessSubList
,AbstractBooleanList.BooleanSubList
,BooleanArrayList
,BooleanImmutableList
,BooleanLists.EmptyList
,BooleanLists.Singleton
,BooleanLists.SynchronizedList
,BooleanLists.SynchronizedRandomAccessList
,BooleanLists.UnmodifiableList
,BooleanLists.UnmodifiableRandomAccessList
public interface BooleanList extends java.util.List<java.lang.Boolean>, java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>, BooleanCollection
A type-specificList
; provides some additional methods that use polymorphism to avoid (un)boxing.Note that this type-specific interface extends
Comparable
: it is expected that implementing classes perform a lexicographical comparison using the standard operator "less then" for primitive types, and the usualcompareTo()
method for objects.Additionally, this interface strengthens
iterator()
,listIterator()
,listIterator(int)
andsubList(int,int)
. The former had been already strengthened upstream, but unfortunatelyList
re-specifies it.Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.
- See Also:
List
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
add(boolean key)
Appends the specified element to the end of this list (optional operation).void
add(int index, boolean key)
Inserts the specified element at the specified position in this list (optional operation).default void
add(int index, java.lang.Boolean key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
add(java.lang.Boolean k)
Deprecated.Please use the corresponding type-specific method instead.boolean
addAll(int index, BooleanCollection c)
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).default boolean
addAll(int index, BooleanList l)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).default boolean
addAll(BooleanList l)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).void
addElements(int index, boolean[] a)
Add (hopefully quickly) elements to this type-specific list.void
addElements(int index, boolean[] a, int offset, int length)
Add (hopefully quickly) elements to this type-specific list.default boolean
contains(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default java.lang.Boolean
get(int index)
Deprecated.Please use the corresponding type-specific method instead.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 (hopefully quickly) elements of this type-specific list into the given array.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.default int
indexOf(java.lang.Object o)
Deprecated.Please use the corresponding type-specific method instead.BooleanListIterator
iterator()
Returns a type-specific iterator on the elements of this list.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.default int
lastIndexOf(java.lang.Object o)
Deprecated.Please use the corresponding type-specific method instead.BooleanListIterator
listIterator()
Returns a type-specific list iterator on the list.BooleanListIterator
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.static BooleanList
of()
Returns an immutable empty list.static BooleanList
of(boolean e)
Returns an immutable list with the element given.static BooleanList
of(boolean... a)
Returns an immutable list with the elements given.static BooleanList
of(boolean e0, boolean e1)
Returns an immutable list with the elements given.static BooleanList
of(boolean e0, boolean e1, boolean e2)
Returns an immutable list with the elements given.default java.lang.Boolean
remove(int index)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.boolean
removeBoolean(int index)
Removes the element at the specified position in this list (optional operation).void
removeElements(int from, int to)
Removes (hopefully quickly) elements of this type-specific list.default void
replaceAll(BooleanUnaryOperator operator)
Replaces each element of this list with the result of applying the operator to that element.default void
replaceAll(java.util.function.UnaryOperator<java.lang.Boolean> operator)
Deprecated.Please use the corresponding type-specific method instead.boolean
set(int index, boolean k)
Replaces the element at the specified position in this list with the specified element (optional operation).default java.lang.Boolean
set(int index, java.lang.Boolean k)
Deprecated.Please use the corresponding type-specific method instead.default void
setElements(boolean[] a)
Set (hopefully quickly) elements to match the array given.default void
setElements(int index, boolean[] a)
Set (hopefully quickly) elements to match the array given.default void
setElements(int index, boolean[] a, int offset, int length)
Set (hopefully quickly) elements to match the array given.void
size(int size)
Sets the size of this list.default void
sort(BooleanComparator comparator)
Sort a list using a type-specific comparator.default void
sort(java.util.Comparator<? super java.lang.Boolean> comparator)
Deprecated.Please use the corresponding type-specific method instead.default BooleanSpliterator
spliterator()
Returns a type-specific spliterator on the elements of this list.BooleanList
subList(int from, int to)
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.default void
unstableSort(BooleanComparator comparator)
Sorts this list using a sort not assured to be stable.default void
unstableSort(java.util.Comparator<? super java.lang.Boolean> comparator)
Deprecated.Please use the corresponding type-specific method instead.-
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
addAll, contains, containsAll, rem, removeAll, removeIf, removeIf, retainAll, toArray, toBooleanArray, toBooleanArray
-
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanIterable
forEach, forEach
-
-
-
-
Method Detail
-
iterator
BooleanListIterator iterator()
Returns a type-specific iterator on the elements of this list.- Specified by:
iterator
in interfaceBooleanCollection
- Specified by:
iterator
in interfaceBooleanIterable
- Specified by:
iterator
in interfacejava.util.Collection<java.lang.Boolean>
- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.Boolean>
- Specified by:
iterator
in interfacejava.util.List<java.lang.Boolean>
- Returns:
- an iterator on the elements of this list.
- See Also:
Iterable.iterator()
- API Notes:
- This specification strengthens the one given in
List.iterator()
. It would not be normally necessary, butIterable.iterator()
is bizarrily re-specified inList
.Also, this is generally the only
iterator
method subclasses should override.
-
spliterator
default BooleanSpliterator spliterator()
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 interfacejava.util.Collection<java.lang.Boolean>
- Specified by:
spliterator
in interfacejava.lang.Iterable<java.lang.Boolean>
- Specified by:
spliterator
in interfacejava.util.List<java.lang.Boolean>
- Returns:
- a type-specific spliterator on the elements of this collection.
- Since:
- 8.5.0
- API Notes:
- This specification strengthens the one given in
Collection.spliterator()
, which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extendsList
.Also, this is generally the only
spliterator
method subclasses should override. - Implementation Specification:
- The default implementation returns a late-binding spliterator (see
Spliterator
for documentation on what binding policies mean).- For
RandomAccess
lists, this will return a spliterator that calls the type-specificget(int)
method on the appropriate indexes. - Otherwise, the spliterator returned will wrap this instance's type specific
iterator()
.
In either case, the spliterator reports
Spliterator.SIZED
,Spliterator.SUBSIZED
, andSpliterator.ORDERED
. - For
- Implementation Notes:
- As the non-RandomAccess case is based on the
iterator, and
Iterator
is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator'strySplit()
will have linear runtime.For
RandomAccess
lists, the parallel performance should be reasonable assumingget(int)
is truly constant time likeRandomAccess
suggests.
-
listIterator
BooleanListIterator listIterator()
Returns a type-specific list iterator on the list.- Specified by:
listIterator
in interfacejava.util.List<java.lang.Boolean>
- See Also:
List.listIterator()
-
listIterator
BooleanListIterator listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfacejava.util.List<java.lang.Boolean>
- See Also:
List.listIterator(int)
-
subList
BooleanList subList(int from, int to)
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.- Specified by:
subList
in interfacejava.util.List<java.lang.Boolean>
- See Also:
List.subList(int,int)
- API Notes:
- This specification strengthens the one given in
List.subList(int,int)
.
-
size
void size(int size)
Sets the size of this list.If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/
null
/false
.- Parameters:
size
- the new size.
-
getElements
void getElements(int from, boolean[] a, int offset, int length)
Copies (hopefully quickly) elements of this type-specific list into the given array.- Parameters:
from
- the start index (inclusive).a
- the destination array.offset
- the offset into the destination array where to store the first element copied.length
- the number of elements to be copied.
-
removeElements
void removeElements(int from, int to)
Removes (hopefully quickly) elements of this type-specific list.- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).
-
addElements
void addElements(int index, boolean[] a)
Add (hopefully quickly) elements to this type-specific list.- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.
-
addElements
void addElements(int index, boolean[] a, int offset, int length)
Add (hopefully quickly) elements to this type-specific list.- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.offset
- the offset of the first element to add.length
- the number of elements to add.
-
setElements
default void setElements(boolean[] a)
Set (hopefully quickly) elements to match the array given.- Parameters:
a
- the array containing the elements.- Since:
- 8.3.0
-
setElements
default void setElements(int index, boolean[] a)
Set (hopefully quickly) elements to match the array given.- Parameters:
index
- the index at which to start setting elements.a
- the array containing the elements.- Since:
- 8.3.0
-
setElements
default void setElements(int index, boolean[] a, int offset, int length)
Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by
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.ListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(a[offset + i++]); }
- Parameters:
index
- the index at which to start setting elements.a
- the array containing the elementsoffset
- the offset of the first element to add.length
- the number of elements to add.- Since:
- 8.3.0
-
add
boolean add(boolean key)
Appends the specified element to the end of this list (optional operation).- Specified by:
add
in interfaceBooleanCollection
- See Also:
List.add(Object)
-
add
void add(int index, boolean key)
Inserts the specified element at the specified position in this list (optional operation).- See Also:
List.add(int,Object)
-
add
@Deprecated default void add(int index, java.lang.Boolean key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
add
in interfacejava.util.List<java.lang.Boolean>
-
addAll
boolean addAll(int index, BooleanCollection c)
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- See Also:
List.addAll(int,java.util.Collection)
-
set
boolean set(int index, boolean k)
Replaces the element at the specified position in this list with the specified element (optional operation).- See Also:
List.set(int,Object)
-
replaceAll
default void replaceAll(BooleanUnaryOperator operator)
Replaces each element of this list with the result of applying the operator to that element.- Parameters:
operator
- the operator to apply to each element.- See Also:
List.replaceAll(java.util.function.UnaryOperator<E>)
-
replaceAll
@Deprecated default void replaceAll(java.util.function.UnaryOperator<java.lang.Boolean> operator)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
replaceAll
in interfacejava.util.List<java.lang.Boolean>
-
getBoolean
boolean getBoolean(int index)
Returns the element at the specified position in this list.- See Also:
List.get(int)
-
indexOf
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.- See Also:
List.indexOf(Object)
-
lastIndexOf
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.- See Also:
List.lastIndexOf(Object)
-
contains
@Deprecated default boolean contains(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
contains
in interfaceBooleanCollection
- Specified by:
contains
in interfacejava.util.Collection<java.lang.Boolean>
- Specified by:
contains
in interfacejava.util.List<java.lang.Boolean>
-
get
@Deprecated default java.lang.Boolean get(int index)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
get
in interfacejava.util.List<java.lang.Boolean>
-
indexOf
@Deprecated default int indexOf(java.lang.Object o)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
indexOf
in interfacejava.util.List<java.lang.Boolean>
-
lastIndexOf
@Deprecated default int lastIndexOf(java.lang.Object o)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
lastIndexOf
in interfacejava.util.List<java.lang.Boolean>
-
add
@Deprecated default boolean add(java.lang.Boolean k)
Deprecated.Please use the corresponding type-specific method instead.This method specification is a workaround for bug 8177440.
- Specified by:
add
in interfaceBooleanCollection
- Specified by:
add
in interfacejava.util.Collection<java.lang.Boolean>
- Specified by:
add
in interfacejava.util.List<java.lang.Boolean>
-
removeBoolean
boolean removeBoolean(int index)
Removes the element at the specified position in this list (optional operation).- See Also:
List.remove(int)
-
remove
@Deprecated default boolean remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
remove
in interfaceBooleanCollection
- Specified by:
remove
in interfacejava.util.Collection<java.lang.Boolean>
- Specified by:
remove
in interfacejava.util.List<java.lang.Boolean>
-
remove
@Deprecated default java.lang.Boolean remove(int index)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
remove
in interfacejava.util.List<java.lang.Boolean>
-
set
@Deprecated default java.lang.Boolean set(int index, java.lang.Boolean k)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
set
in interfacejava.util.List<java.lang.Boolean>
-
addAll
default boolean addAll(int index, BooleanList l)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- See Also:
List.addAll(int,Collection)
- API Notes:
- This method exists only for the sake of efficiency: override are expected to use
getElements(int, boolean[], int, int)
/addElements(int, boolean[])
. - Implementation Specification:
- This method delegates to the one accepting a collection, but it might be implemented more efficiently.
-
addAll
default boolean addAll(BooleanList l)
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- See Also:
List.addAll(Collection)
- Implementation Specification:
- This method delegates to the index-based version, passing
List.size()
as first argument.
-
of
static BooleanList of()
Returns an immutable empty list.- Returns:
- an immutable empty list.
-
of
static BooleanList of(boolean e)
Returns an immutable list with the element given.- Parameters:
e
- the element that the returned list will contain.- Returns:
- an immutable list containing
e
.
-
of
static BooleanList of(boolean e0, boolean e1)
Returns an immutable list with the elements given.- Parameters:
e0
- the first element.e1
- the second element.- Returns:
- an immutable list containing
e0
ande1
.
-
of
static BooleanList of(boolean e0, boolean e1, boolean e2)
Returns an immutable list with the elements given.- Parameters:
e0
- the first element.e1
- the second element.e2
- the third element.- Returns:
- an immutable list containing
e0
,e1
, ande2
.
-
of
static BooleanList of(boolean... a)
Returns an immutable list with the elements given.Note that this method does not perform a defensive copy.
- Parameters:
a
- a list of elements that will be used to initialize the immutable list.- Returns:
- an immutable list containing the elements of
a
.
-
sort
@Deprecated default void sort(java.util.Comparator<? super java.lang.Boolean> comparator)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
sort
in interfacejava.util.List<java.lang.Boolean>
-
sort
default void sort(BooleanComparator comparator)
Sort a list using a type-specific comparator.Pass
null
to sort using natural ordering.- Since:
- 8.3.0
- See Also:
List.sort(java.util.Comparator)
- Implementation Specification:
- The default implementation dumps the elements into an array using
List.toArray()
, sorts the array, then replaces all elements using thesetElements(boolean[])
function.It is possible for this method to call
unstableSort(java.util.Comparator<? super java.lang.Boolean>)
if it can determine that the results of a stable and unstable sort are completely equivalent. This means if you overrideunstableSort(java.util.Comparator<? super java.lang.Boolean>)
, it should not call this method unless you override this method as well.
-
unstableSort
@Deprecated default void unstableSort(java.util.Comparator<? super java.lang.Boolean> comparator)
Deprecated.Please use the corresponding type-specific method instead.Sorts this list using a sort not assured to be stable.
-
unstableSort
default void unstableSort(BooleanComparator comparator)
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.
- Since:
- 8.3.0
- Implementation Specification:
- The default implementation dumps the elements into an array using
List.toArray()
, sorts the array, then replaces all elements using thesetElements(boolean[])
function.
-
-