org.starchartlabs.alloy.core.collections

Class MoreSpliterators

java.lang.Object

org.starchartlabs.alloy.core.collections.MoreSpliterators

public final class MoreSpliterators
extends java.lang.Object

Provides methods for streamlining and reducing boilerplate for operations related to Java Spliterators

Since:

0.4.0

Constructor Summary

Constructors

Constructor and Description
MoreSpliterators()

Method Summary

Modifier and Type	Method and Description
static <T> java.util.Spliterator<T>	ofPaged(PageIterator<T> pageIterator) Returns a spliterator which allows traversing over elements provided via a paging protocol
static <T,A> java.util.Spliterator<T>	shortCircuit(java.util.Spliterator<T> spliterator, java.util.function.BiFunction<java.util.Optional<A>,? super T,A> accumulator, java.util.function.Predicate<A> completedPredicate) Returns a spliterator which allows stopping traversal when the previously traversed elements meet criteria specified by a predicate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MoreSpliterators

public MoreSpliterators()

Method Detail

shortCircuit

public static <T,A> java.util.Spliterator<T> shortCircuit(java.util.Spliterator<T> spliterator,
                                                          java.util.function.BiFunction<java.util.Optional<A>,? super T,A> accumulator,
                                                          java.util.function.Predicate<A> completedPredicate)

Returns a spliterator which allows stopping traversal when the previously traversed elements meet criteria specified by a predicate. If the predicate condition is never met, the spliterator traverses as normal

The returned spliterator will have a sub-set of the characteristics of the original

Type Parameters:

T - Representation supplied by the provided spliterator

A - Representation of accumulated data from previously traversed rows

Parameters:

spliterator - Original spliterator which traverses elements until complete

accumulator - Function which accepts a representation of previously traversed elements and the current element. If no elements were previously traversed, the provided previous value will be an empty Optional. Must return non-null

completedPredicate - Predicate defining the conditions under which to cease traversal of the spliterator

Returns:

A spliterator which allows short-circuiting traversal based on a predicate

Since:

0.4.0

ofPaged

public static <T> java.util.Spliterator<T> ofPaged(PageIterator<T> pageIterator)

Returns a spliterator which allows traversing over elements provided via a paging protocol

Type Parameters:

T - Representation of a single element in the sequence

Parameters:

pageIterator - A source-specific implementation which handles the protocol for reading a sequence of paged data

Returns:

A spliterator which allows traversing over elements provided via a paging protocol

Since:

0.4.0