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

Class FailStep.FailException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.FailStep.FailException

All Implemented Interfaces:

Serializable, Failure

Enclosing class:

FailStep<S>

public static class FailStep.FailException
extends RuntimeException
implements Failure

Default Failure implementation that is thrown by FailStep.

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getMetadata()	Gets any additional metadata associated with the failure.
Traversal.Admin	getTraversal()	Gets the Traversal that contained the fail() step that triggered the failure.
Traverser.Admin	getTraverser()	Gets the Traverser that was being processed when the failure was triggered.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

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

format, getMessage

Constructor Details

FailException

public FailException(Traversal.Admin traversal,
 Traverser.Admin traverser,
 String message,
 Map<String,Object> metadata)

Method Details

getMetadata

public Map<String,Object> getMetadata()

Description copied from interface: Failure

Gets any additional metadata associated with the failure. Returns an empty Map when there is no metadata.

Specified by:

getMetadata in interface Failure

getTraverser

public Traverser.Admin getTraverser()

Description copied from interface: Failure

Gets the Traverser that was being processed when the failure was triggered. May return null when the Failure was reconstructed from a remote response where this context is not available.

Specified by:

getTraverser in interface Failure

getTraversal

public Traversal.Admin getTraversal()

Description copied from interface: Failure

Gets the Traversal that contained the fail() step that triggered the failure. May return null when the Failure was reconstructed from a remote response where this context is not available.

Specified by:

getTraversal in interface Failure