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

Interface Configuring

All Superinterfaces:

Parameterizing

All Known Subinterfaces:

Mutating<E>, ReadWriting

All Known Implementing Classes:

AddEdgeStartStep, AddEdgeStep, AddPropertyStep, AddVertexStartStep, AddVertexStep, ConnectedComponentVertexProgramStep, DropStep, EdgeOtherVertexStep, EdgeVertexStep, GraphStep, HasStep, IndexStep, IoStep, PageRankVertexProgramStep, PeerPressureVertexProgramStep, PropertiesStep, PropertyMapStep, ShortestPathVertexProgramStep, TinkerGraphStep, TraversalFilterStep, VertexStep

public interface Configuring
extends Parameterizing

Identifies a Step as one that can accept configurations via the GraphTraversal.with(String, Object) step modulator. The nature of the configuration allowed is specific to the implementation.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Method Summary

Modifier and Type	Method and Description
void	configure(Object... keyValues) Accept a configuration to the Step.

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Parameterizing

getParameters

Method Detail

configure

void configure(Object... keyValues)

Accept a configuration to the Step. Note that this interface extends Parameterizing and so there is an expectation that the Step implementation will have a Parameters instance that will house any values passed to this method. Storing these configurations in Parameters is not a requirement however, IF the configuration is an expected option for the step and can be stored on a member field that can be accessed on the step by more direct means (i.e. like a getter method).