Class BooleanSpliterators
 Since:
 8.5.0
 Author:
 C. Sean Young <csyoung@google.com>
 See Also:

Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A skeletal implementation for a spliterator backed by an index based data store.static class
A skeletal implementation for a spliterator backed by an index based data store.static class
A class returning no elements and a typespecific spliterator interface.static class
A skeletal implementation for a spliterator backed by an index based data store. 
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final BooleanSpliterators.EmptySpliterator
An empty spliterator.static final int
static final int
static final int

Method Summary
Modifier and TypeMethodDescriptionstatic BooleanSpliterator
Wraps a standard spliterator into a typespecific spliterator.static BooleanSpliterator
asBooleanSpliterator
(Spliterator i, BooleanComparator comparatorOverride) Wraps a standard spliterator into a typespecific spliterator.static BooleanIterator
asIterator
(BooleanSpliterator spliterator) Wrap a typespecificSpliterator
as a typespecificIterator
static BooleanSpliterator
asSpliterator
(BooleanIterator iter, long size, int additionalCharacterisitcs) Wrap a typespecificIterator
of a known size as a typespecificSpliterator
static BooleanSpliterator
asSpliteratorFromSorted
(BooleanIterator iter, long size, int additionalCharacterisitcs, BooleanComparator comparator) Wrap a typespecific, sortedIterator
of a known size as a typespecificSpliterator
static BooleanSpliterator
asSpliteratorFromSortedUnknownSize
(BooleanIterator iter, int additionalCharacterisitcs, BooleanComparator comparator) Wrap a typespecific, sortedIterator
of an unknown size as a typespecificSpliterator
static BooleanSpliterator
asSpliteratorUnknownSize
(BooleanIterator iter, int characterisitcs) Wrap a typespecificIterator
of an unknown size as a typespecificSpliterator
static BooleanSpliterator
concat
(BooleanSpliterator... a) Concatenates all spliterators contained in an array.static BooleanSpliterator
concat
(BooleanSpliterator[] a, int offset, int length) Concatenates a sequence of spliterators contained in an array.static void
onEachMatching
(BooleanSpliterator spliterator, BooleanPredicate predicate, BooleanConsumer action) Perform the givenaction
on each element that matches the givenpredicate
.static BooleanSpliterator
singleton
(boolean element) Returns a spliterator that iterates just over the given element.static BooleanSpliterator
singleton
(boolean element, BooleanComparator comparator) Returns a spliterator that iterates just over the given element.static BooleanSpliterator
wrap
(boolean[] array) Wraps the given array into a typespecific spliterator.static BooleanSpliterator
wrap
(boolean[] array, int offset, int length) Wraps the given part of an array into a typespecific spliterator.static BooleanSpliterator
wrap
(boolean[] array, int offset, int length, int additionalCharacteristics) Wraps the given part of an array into a typespecific spliterator.static BooleanSpliterator
wrapPreSorted
(boolean[] array, int offset, int length, int additionalCharacteristics, BooleanComparator comparator) Wraps the given part of a sorted array into a typespecific spliterator.static BooleanSpliterator
wrapPreSorted
(boolean[] array, int offset, int length, BooleanComparator comparator) Wraps the given part of a sorted array into a typespecific spliterator.static BooleanSpliterator
wrapPreSorted
(boolean[] array, BooleanComparator comparator) Wraps the given sorted array into a typespecific spliterator.

Field Details

COLLECTION_SPLITERATOR_CHARACTERISTICS
public static final int COLLECTION_SPLITERATOR_CHARACTERISTICS See Also:

LIST_SPLITERATOR_CHARACTERISTICS
public static final int LIST_SPLITERATOR_CHARACTERISTICS See Also:

SET_SPLITERATOR_CHARACTERISTICS
public static final int SET_SPLITERATOR_CHARACTERISTICS See Also:

SORTED_SET_SPLITERATOR_CHARACTERISTICS
public static final int SORTED_SET_SPLITERATOR_CHARACTERISTICS See Also:

EMPTY_SPLITERATOR
An empty spliterator. It is serializable and cloneable.The class of this objects represent an abstract empty spliterator that can iterate as a typespecific spliterator.


Method Details

singleton
Returns a spliterator that iterates just over the given element. Parameters:
element
 the only element to be returned by a typespecific spliterator. Returns:
 a spliterator that iterates just over
element
.

singleton
Returns a spliterator that iterates just over the given element.The
Spliterator.getComparator()
method will return the given comparator. This is within spec because sequences of size 1 are trivially sorted for any comparison function. Parameters:
element
 the only element to be returned by a typespecific spliterator.comparator
 the comparator to return whenSpliterator.getComparator()
is called. Returns:
 a spliterator that iterates just over
element
.

wrap
Wraps the given part of an array into a typespecific spliterator.The typespecific spliterator returned by this method will iterate
length
times, advancing over consecutive elements of the given array starting from the one with indexoffset
.The returned spliterator will report characteristics
Spliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
, and for primitive arrays,Spliterator.NONNULL
. Parameters:
array
 an array to wrap into a typespecific spliterator.offset
 the first element of the array to be returned.length
 the number of elements to return. Returns:
 a spliterator that will iterate over
length
elements ofarray
starting at positionoffset
.

wrap
Wraps the given array into a typespecific spliterator.The typespecific spliterator returned by this method will advance over all elements of the given array.
The returned spliterator will report characteristics
Spliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
, and for primitive arrays,Spliterator.NONNULL
. Parameters:
array
 an array to wrap into a typespecific spliterator. Returns:
 a spliterator that will iterate over the elements of
array
.

wrap
public static BooleanSpliterator wrap(boolean[] array, int offset, int length, int additionalCharacteristics) Wraps the given part of an array into a typespecific spliterator.The typespecific spliterator returned by this method will iterate
length
times, advancing over consecutive elements of the given array starting from the one with indexoffset
.The returned spliterator will report characteristics
Spliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
, and for primitive arrays,Spliterator.NONNULL
, on top of any additional characteristics given inadditionalCharacteristics
(for example, if the caller knows the backing array has distinct elements, they can passSpliterator.DISTINCT
). Parameters:
array
 an array to wrap into a typespecific spliterator.offset
 the first element of the array to be returned.length
 the number of elements to return.additionalCharacteristics
 any additional characteristics to report. Returns:
 a spliterator that will iterate over
length
elements ofarray
starting at positionoffset
.

wrapPreSorted
public static BooleanSpliterator wrapPreSorted(boolean[] array, int offset, int length, int additionalCharacteristics, BooleanComparator comparator) Wraps the given part of a sorted array into a typespecific spliterator.It is the caller's responsibility to ensure the array is actually sorted using the comparator given.
The typespecific spliterator returned by this method will iterate
length
times, advancing over consecutive elements of the given array starting from the one with indexoffset
.The returned spliterator will report characteristics
Spliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
,Spliterator.SORTED
, and for primitive arrays,Spliterator.NONNULL
, on top of any additional characteristics given inadditionalCharacteristics
(for example, if the caller knows the backing array has distinct elements, they can passSpliterator.DISTINCT
). Parameters:
array
 an array to wrap into a typespecific spliterator.offset
 the first element of the array to be returned.length
 the number of elements to return.additionalCharacteristics
 any additional characteristics to report.comparator
 the comparator the array was sorted with (ornull
for natural ordering) Returns:
 a spliterator that will iterate over
length
elements ofarray
starting at positionoffset
.

wrapPreSorted
public static BooleanSpliterator wrapPreSorted(boolean[] array, int offset, int length, BooleanComparator comparator) Wraps the given part of a sorted array into a typespecific spliterator.It is the caller's responsibility to ensure the array is actually sorted using the comparator given.
The typespecific spliterator returned by this method will iterate
length
times, advancing over consecutive elements of the given array starting from the one with indexoffset
.The returned spliterator will report characteristics
Spliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
,Spliterator.SORTED
, and for primitive arrays,Spliterator.NONNULL
. Parameters:
array
 an array to wrap into a typespecific spliterator.offset
 the first element of the array to be returned.length
 the number of elements to return.comparator
 the comparator the array was sorted with (ornull
for natural ordering) Returns:
 a spliterator that will iterate over
length
elements ofarray
starting at positionoffset
.

wrapPreSorted
Wraps the given sorted array into a typespecific spliterator.It is the caller's responsibility to ensure the array is actually sorted using the comparator given.
The typespecific spliterator returned by this method will advance over all elements of the given array.
The returned spliterator will report characteristics
Spliterator.SIZED
,Spliterator.SUBSIZED
,Spliterator.ORDERED
,Spliterator.SORTED
, and for primitive arrays,Spliterator.NONNULL
. Parameters:
array
 an array to wrap into a typespecific spliterator.comparator
 the comparator the array was sorted with (ornull
for natural ordering) Returns:
 a spliterator that will iterate over
length
elements ofarray
starting at positionoffset
.

asBooleanSpliterator
Wraps a standard spliterator into a typespecific spliterator.This method wraps a standard spliterator into a typespecific one which will handle the type conversions for you. Of course, any attempt to wrap a spliterator returning the instances of the wrong class will generate a
ClassCastException
. The returned spliterator is backed byi
: changes to one of the spliterators will affect the other, too.If
i
is already typespecific, it will returned and no new object will be generated. Parameters:
i
 a spliterator. Returns:
 a typespecific spliterator backed by
i
.

asBooleanSpliterator
public static BooleanSpliterator asBooleanSpliterator(Spliterator i, BooleanComparator comparatorOverride) Wraps a standard spliterator into a typespecific spliterator.This method wraps a standard spliterator into a typespecific one which will handle the type conversions for you. Of course, any attempt to wrap a spliterator returning the instances of the wrong class will generate a
ClassCastException
. The returned spliterator is backed byi
: changes to one of the spliterators will affect the other, too.This method will cause the returned spliterator's
Spliterator.getComparator()
method to always returncomparatorOverride
, regardless of what the wrapped spliterator'sgetComparator()
method returns.NOTE:This is mostly intended for supporting default implementations in interfaces that wrap JDK spliterators, and not a general purpose method.
If
i
is already typespecific, this method will throw, as such spliterators already have agetComparator()
that returns a properly typed comparator. Parameters:
i
 a spliterator.comparatorOverride
 the comparator to return whenSpliterator.getComparator()
 Returns:
 a typespecific spliterator backed by
i
.

onEachMatching
public static void onEachMatching(BooleanSpliterator spliterator, BooleanPredicate predicate, BooleanConsumer action) Perform the givenaction
on each element that matches the givenpredicate
.This is equivalent to
java.util.stream.StreamSupport.stream(spliterator).filter(predicate).forEach(action)
(substitute the proper primitive stream as needed), except it may perform better (but no potential for parallelism). 
concat
Concatenates all spliterators contained in an array.This method returns a spliterator that will enumerate in order the elements returned by all spliterators contained in the given array.
Note: Due to there being no way to ensure the
Comparator
is consistent between each inner spliterator, the returned spliterator'sSpliterator.getComparator()
will always throwIllegalStateException
, even when if the current or even all the inner spliterators are sorted. Parameters:
a
 an array of spliterators. Returns:
 a spliterator obtained by concatenation.

concat
Concatenates a sequence of spliterators contained in an array.This method returns a spliterator that will enumerate in order the elements returned by
a[offset]
, then those returned bya[offset + 1]
, and so on up toa[offset + length  1]
.Note: Due to there being no way to ensure the
Comparator
is consistent between each inner spliterator, the returned spliterator'sSpliterator.getComparator()
will always throwIllegalStateException
, even when if the current or even all the inner spliterators are sorted. Parameters:
a
 an array of spliterators.offset
 the index of the first spliterator to concatenate.length
 the number of spliterators to concatenate. Returns:
 a spliterator obtained by concatenation of
length
elements ofa
starting atoffset
.

asSpliterator
public static BooleanSpliterator asSpliterator(BooleanIterator iter, long size, int additionalCharacterisitcs) Wrap a typespecificIterator
of a known size as a typespecificSpliterator
The returned spliterator will report
characteristics
additionalCharacterisitcs
, and for primitive types,Spliterator.NONNULL
. It will also reportSpliterator.SIZED
,Spliterator.SUBSIZED
, unlessSpliterator.CONCURRENT
is to be reported, in which case these two are not implicitly reported.Because
Iterator
is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator'sSpliterator.trySplit()
will have linear runtime. Parameters:
iter
 the typespecificIterator
to wrapsize
 the number of elements the iterator will returnadditionalCharacterisitcs
 any additional characteristics to report Returns:
 a typespecific
Spliterator
that will give the same elements the iterator will return.  See Also:

asSpliteratorFromSorted
public static BooleanSpliterator asSpliteratorFromSorted(BooleanIterator iter, long size, int additionalCharacterisitcs, BooleanComparator comparator) Wrap a typespecific, sortedIterator
of a known size as a typespecificSpliterator
It is the caller's responsibility to ensure the iterator's order is actually sorted according to the comparator given.
The returned spliterator will report
characteristics
additionalCharacterisitcs
,Spliterator.ORDERED
,Spliterator.SORTED
, and for primitive types,Spliterator.NONNULL
. It will also reportSpliterator.SIZED
,Spliterator.SUBSIZED
, unlessSpliterator.CONCURRENT
is to be reported, in which case these two are not implicitly reported.Because
Iterator
is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator'sSpliterator.trySplit()
will have linear runtime. Parameters:
iter
 the typespecificIterator
to wrapsize
 the number of elements the iterator will returnadditionalCharacterisitcs
 any additional characteristics to reportcomparator
 the comparator the iterator is ordered on (ornull
for natural ordering) Returns:
 a typespecific
Spliterator
that will give the same elements the iterator will return.

asSpliteratorUnknownSize
public static BooleanSpliterator asSpliteratorUnknownSize(BooleanIterator iter, int characterisitcs) Wrap a typespecificIterator
of an unknown size as a typespecificSpliterator
The returned spliterator will report
additionalCharacterisitcs
, and for primitive types,Spliterator.NONNULL
.Because
Iterator
is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator'sSpliterator.trySplit()
will have linear runtime. Parameters:
iter
 the typespecificIterator
to wrapcharacterisitcs
 the characteristics to report Returns:
 a typespecific
Spliterator
that will give the same elements the iterator will return.  See Also:

asSpliteratorFromSortedUnknownSize
public static BooleanSpliterator asSpliteratorFromSortedUnknownSize(BooleanIterator iter, int additionalCharacterisitcs, BooleanComparator comparator) Wrap a typespecific, sortedIterator
of an unknown size as a typespecificSpliterator
It is the caller's responsibility to ensure the iterator's order is actually sorted according to the comparator given.
The returned spliterator will report
characteristics
additionalCharacterisitcs
,Spliterator.ORDERED
,Spliterator.SORTED
, and for primitive types,Spliterator.NONNULL
.Because
Iterator
is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator'sSpliterator.trySplit()
will have linear runtime. Parameters:
iter
 the typespecificIterator
to wrapadditionalCharacterisitcs
 the characteristics to reportcomparator
 the comparator the iterator is ordered on (ornull
for natural ordering) Returns:
 a typespecific
Spliterator
that will give the same elements the iterator will return.

asIterator
Wrap a typespecificSpliterator
as a typespecificIterator
 Parameters:
spliterator
 the typespecificSpliterator
to wrap Returns:
 a typespecific
Iterator
that will return the same elements the spliterator will give.  See Also:
