HaltedTraverserStrategy (Apache TinkerPop 3.6.5 API)

java.lang.Object
- org.apache.tinkerpop.gremlin.process.traversal.strategy.AbstractTraversalStrategy<TraversalStrategy.DecorationStrategy>
- - org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.HaltedTraverserStrategy

All Implemented Interfaces:

Serializable, Comparable<Class<? extends TraversalStrategy>>, TraversalStrategy<TraversalStrategy.DecorationStrategy>, TraversalStrategy.DecorationStrategy
```
public final class HaltedTraverserStrategy
extends AbstractTraversalStrategy<TraversalStrategy.DecorationStrategy>
implements TraversalStrategy.DecorationStrategy
```
Author:

Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy
  TraversalStrategy.DecorationStrategy, TraversalStrategy.FinalizationStrategy, TraversalStrategy.OptimizationStrategy, TraversalStrategy.ProviderOptimizationStrategy, TraversalStrategy.VerificationStrategy

Field Summary

Fields
Modifier and Type Field Description

static String HALTED_TRAVERSER_FACTORY
- Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy
  STRATEGY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply(Traversal.Admin<?,?> traversal)`
`static HaltedTraverserStrategy`	`create(org.apache.commons.configuration2.Configuration configuration)`
`static HaltedTraverserStrategy`	`detached()`
`org.apache.commons.configuration2.Configuration`	`getConfiguration()`	Get the configuration representation of this strategy.
`Class`	`getHaltedTraverserFactory()`
`<R> Traverser.Admin<R>`	`halt(Traverser.Admin<R> traverser)`
`static HaltedTraverserStrategy`	`reference()`

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.strategy.AbstractTraversalStrategy
equals, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy
applyPost, applyPrior

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy.DecorationStrategy
compareTo, getTraversalCategory

- Field Detail
  - HALTED_TRAVERSER_FACTORY
```
public static final String HALTED_TRAVERSER_FACTORY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - apply
```
public void apply(Traversal.Admin<?,?> traversal)
```
    Specified by:
    
    apply in interface TraversalStrategy<TraversalStrategy.DecorationStrategy>
  - getHaltedTraverserFactory
```
public Class getHaltedTraverserFactory()
```
  - halt
```
public <R> Traverser.Admin<R> halt(Traverser.Admin<R> traverser)
```
  - create
```
public static HaltedTraverserStrategy create(org.apache.commons.configuration2.Configuration configuration)
```
  - getConfiguration
```
public org.apache.commons.configuration2.Configuration getConfiguration()
```
    Description copied from interface: TraversalStrategy
    
    Get the configuration representation of this strategy. This is useful for converting a strategy into a serialized form.
    
    Specified by:
    
    getConfiguration in interface TraversalStrategy<TraversalStrategy.DecorationStrategy>
    
    Returns:
    
    the configuration used to create this strategy
  - detached
```
public static HaltedTraverserStrategy detached()
```
  - reference
```
public static HaltedTraverserStrategy reference()
```