Interface Replacer

@Experimental
@Pro
public interface Replacer

An API for QueryPart.$replace(Replacer) query part transformations.

This API is EXPERIMENTAL. Use at your own risk.

See replacer() for the contract that must be obeyed by the replacer() function.

Method Summary

Modifier and Type	Method	Description
static Replacer	of(Function<? super QueryPart, ? extends QueryPart> replacer)	Convenience method to create a Replacer with a replacer().
static Replacer	of(Predicate<? super QueryPart> recurse, Function<? super QueryPart, ? extends QueryPart> replacer)	Convenience method to create a Replacer with a recurse() and replacer().
Predicate<QueryPart>	recurse()	An optional recursion condition to prevent entering a specific subtree, e.g.
Function<QueryPart, QueryPart>	replacer()	A callback that is invoked on all elements of the QueryPart expression tree.

Method Details

of

static Replacer of(Function<? super QueryPart, ? extends QueryPart> replacer)

Convenience method to create a Replacer with a replacer().

of

static Replacer of(Predicate<? super QueryPart> recurse,
 Function<? super QueryPart, ? extends QueryPart> replacer)

Convenience method to create a Replacer with a recurse() and replacer().

recurse

Predicate<QueryPart> recurse()

An optional recursion condition to prevent entering a specific subtree, e.g. when it is undesired to enter any subqueries.

replacer

Function<QueryPart, QueryPart> replacer()

A callback that is invoked on all elements of the QueryPart expression tree.

Any such callback must obey the following contract:

• If an input QueryPart is to be left unmodified, the same instance must be returned by the function.
• If an input QueryPart is being replaced, the returned QueryPart must be of a reasonably compatible type, which includes: Field, Row, Condition, Table, Select, Query, Queries