ball.util

Class Walker<T>

java.lang.Object

java.util.Spliterators.AbstractSpliterator<T>

ball.util.Walker<T>

Type Parameters:

T - The type of node.

All Implemented Interfaces:

Spliterator<T>

public class Walker<T>
extends Spliterators.AbstractSpliterator<T>

Spliterator implemenation to build Streams to walk a tree of <T> nodes. See walk(Object,Function).

Version:

$Revision: 6137 $

Author:

Allen D. Ball

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Method Summary

Modifier and Type	Method and Description
boolean	tryAdvance(Consumer<? super T> consumer)
Spliterator<T>	trySplit()
static <T> Stream<T>	walk(Collection<? extends T> roots, Function<? super T,Collection<? extends T>> childrenOf) Entry-point to create a Stream for traversing a tree of type <T> nodes.
static <T> Stream<T>	walk(T root, Function<? super T,Collection<? extends T>> childrenOf) Entry-point to create a Stream for traversing a tree of type <T> nodes.

Methods inherited from class java.util.Spliterators.AbstractSpliterator

characteristics, estimateSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Method Detail

trySplit

public Spliterator<T> trySplit()

Specified by:

trySplit in interface Spliterator<T>

Overrides:

trySplit in class Spliterators.AbstractSpliterator<T>

tryAdvance

public boolean tryAdvance(Consumer<? super T> consumer)

walk

public static <T> Stream<T> walk(T root,
                                 Function<? super T,Collection<? extends T>> childrenOf)

Entry-point to create a Stream for traversing a tree of type <T> nodes. The caller need only supply the root node and a Function to calculate the children nodes.

Type Parameters:

T - The type of node.

Parameters:

root - The root node.

childrenOf - The Function to get the children of a node.

Returns:

A Stream.

walk

public static <T> Stream<T> walk(Collection<? extends T> roots,
                                 Function<? super T,Collection<? extends T>> childrenOf)

Entry-point to create a Stream for traversing a tree of type <T> nodes. The caller need only supply the root nodes and a Function to calculate the children nodes.

Type Parameters:

T - The type of node.

Parameters:

roots - The root nodes.

childrenOf - The Function to get the children of a node.

Returns:

A Stream.