Class Traversers

java.lang.Object

org.jooq.Traversers

@Experimental
@Pro
public final class Traversers
extends Object

A set of Traverser constructor methods.

This API is EXPERIMENTAL. Use at your own risk.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
static <T,R> Traverser<?,R>	collecting(Collector<QueryPart, T, R> collector)	A traverser constructed from a Collector.
static @NotNull Traverser<?,?>	consuming(Consumer<? super QueryPart> consumer)	A traverser that traverses the QueryPart tree without producing any results.
static @NotNull Traverser<?,Boolean>	containing(Predicate<? super QueryPart> predicate)	A traverser that checks whether Predicate is satisfied by any QueryPart in the expression tree.
static @NotNull Traverser<?,Boolean>	containing(QueryPart part)	A traverser that checks whether a QueryPart contains another QueryPart.
static @NotNull Traverser<?, List<QueryPart>>	findingAll(Predicate<? super QueryPart> predicate)	A traverser that finds all QueryParts that satisfy a predicate within the traversed QueryPart tree.
static @NotNull Traverser<?, Optional<QueryPart>>	findingAny(Predicate<? super QueryPart> predicate)	A traverser that finds any QueryPart that satisfies a predicate within the traversed QueryPart tree.
static <A,R> Traverser<?,R>	recursing(Predicate<? super QueryPart> recurse, Traverser<A,R> downstream)	Combine a recursion test predicate with an existing Traverser.
static <A,R> Traverser<?,R>	recursingChildren(Predicate<? super QueryPart> recurseChildren, Traverser<A,R> downstream)	Combine a recursion test predicate with an existing Traverser.

Methods inherited from class Object

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

Method Details

recursing

public static <A,R> Traverser<?,R> recursing(Predicate<? super QueryPart> recurse,
 Traverser<A,R> downstream)

Combine a recursion test predicate with an existing Traverser.

Both the provided predicate and the downstream's Traverser.recurse() must yield true.

recursingChildren

public static <A,R> Traverser<?,R> recursingChildren(Predicate<? super QueryPart> recurseChildren,
 Traverser<A,R> downstream)

Combine a recursion test predicate with an existing Traverser.

Both the provided predicate and the downstream's Traverser.recurseChildren() must yield true.

collecting

public static <T,R> Traverser<?,R> collecting(Collector<QueryPart, T, R> collector)

A traverser constructed from a Collector.

containing

@NotNull
public static @NotNull Traverser<?,Boolean> containing(QueryPart part)

A traverser that checks whether a QueryPart contains another QueryPart.

Parameters:

part - The part to find within the traversed QueryPart tree.

containing

@NotNull
public static @NotNull Traverser<?,Boolean> containing(Predicate<? super QueryPart> predicate)

A traverser that checks whether Predicate is satisfied by any QueryPart in the expression tree.

Parameters:

predicate - The predicate to use to check the traversed tree for a QueryPart to find.

findingAny

@NotNull
public static @NotNull Traverser<?, Optional<QueryPart>> findingAny(Predicate<? super QueryPart> predicate)

A traverser that finds any QueryPart that satisfies a predicate within the traversed QueryPart tree.

Parameters:

predicate - The predicate to use to check the traversed tree for a QueryPart to find.

findingAll

@NotNull
public static @NotNull Traverser<?, List<QueryPart>> findingAll(Predicate<? super QueryPart> predicate)

A traverser that finds all QueryParts that satisfy a predicate within the traversed QueryPart tree.

Parameters:

predicate - The predicate to use to check the traversed tree for QueryParts to find.

consuming

@NotNull
public static @NotNull Traverser<?,?> consuming(Consumer<? super QueryPart> consumer)

A traverser that traverses the QueryPart tree without producing any results.

This is useful for side effectful traversers, e.g. assertions throwing exceptions, etc.

Parameters:

consumer - The consumer that receives all QueryParts.

Returns:

The resulting Traverser always produces null.