Class BaseTraversalStep<StepType,DataType>

java.lang.Object

com.bazaarvoice.jolt.traversr.traversal.BaseTraversalStep<StepType,DataType>

All Implemented Interfaces:

TraversalStep<StepType,DataType>

Direct Known Subclasses:

ArrayTraversalStep, MapTraversalStep

public abstract class BaseTraversalStep<StepType,DataType>
extends Object
implements TraversalStep<StepType,DataType>

Nested Class Summary

Nested classes/interfaces inherited from interface TraversalStep

TraversalStep.Operation

Field Summary

Fields

Modifier and Type	Field	Description
protected final TraversalStep	child
protected final Traversr	traversr

Constructor Summary

Constructors

Constructor	Description
BaseTraversalStep(Traversr traversr, TraversalStep child)

Method Summary

Modifier and Type	Method	Description
TraversalStep	getChild()
final Optional<DataType>	traverse(StepType tree, TraversalStep.Operation op, Iterator<String> keys, DataType data)	The meat of the Traversal.

Methods inherited from class Object

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

Methods inherited from interface TraversalStep

get, getStepType, newContainer, overwriteSet, remove

Field Details

child

protected final TraversalStep child

traversr

protected final Traversr traversr

Constructor Details

BaseTraversalStep

public BaseTraversalStep(Traversr traversr,
 TraversalStep child)

Method Details

getChild

public TraversalStep getChild()

Specified by:

getChild in interface TraversalStep<StepType,DataType>

Returns:

the child Traversal or null if this Traversal has no child

traverse

public final Optional<DataType> traverse(StepType tree,
 TraversalStep.Operation op,
 Iterator<String> keys,
 DataType data)

Description copied from interface: TraversalStep

The meat of the Traversal. Pull a key from the iterator, use it to make the traversal, and then call traverse on your child Traversal.

Specified by:

traverse in interface TraversalStep<StepType,DataType>

Parameters:

tree - tree of data to walk

op - the Operation to perform is this is the last node of the Traversal

keys - keys to use

data - the data to place if the operation is SET

Returns:

if SET, null for fail or the "data" object for ok. if GET, PANTS