Package org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect

Class FailStep<S>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.FailStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>

public class FailStep<S>
extends SideEffectStep<S>

Triggers an immediate failure of the traversal by throwing a RuntimeException. The exception thrown must implement the Failure interface.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FailStep.FailException	Default Failure implementation that is thrown by FailStep.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	message
protected Map<String,Object>	metadata

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
FailStep(Traversal.Admin traversal)
FailStep(Traversal.Admin traversal, String message)
FailStep(Traversal.Admin traversal, String message, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
String	getMessage()
protected void	sideEffect(Traverser.Admin<S> traverser)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep

processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hashCode, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

equals, getRequirements

Field Details

message

protected String message

metadata

protected Map<String,Object> metadata

Constructor Details

FailStep

public FailStep(Traversal.Admin traversal)

FailStep

public FailStep(Traversal.Admin traversal,
 String message)

FailStep

public FailStep(Traversal.Admin traversal,
 String message,
 Map<String,Object> metadata)

Method Details

getMessage

public String getMessage()

sideEffect

protected void sideEffect(Traverser.Admin<S> traverser)

Specified by:

sideEffect in class SideEffectStep<S>