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

Interface Configuring

All Superinterfaces:
Parameterizing
All Known Subinterfaces:
AddEdgeStepContract<S>, AddElementStepContract<S,E>, AddPropertyStepContract<S>, AddVertexStepContract<S>, CallStepContract<S,E>, GraphStepContract<S,E>, ReadWriting, VertexStepContract<E>
All Known Implementing Classes:
AbstractAddEdgeStepPlaceholder, AbstractAddElementStepPlaceholder, AbstractAddVertexStepPlaceholder, AddEdgeStartStep, AddEdgeStartStepPlaceholder, AddEdgeStep, AddEdgeStepPlaceholder, AddPropertyStep, AddPropertyStepPlaceholder, AddVertexStartStep, AddVertexStartStepPlaceholder, AddVertexStep, AddVertexStepPlaceholder, CallStep, CallStepPlaceholder, ConnectedComponentVertexProgramStep, DeclarativeMatchStep, EdgeOtherVertexStep, EdgeVertexStep, GqlMatchStep, GraphStep, GraphStepPlaceholder, HasStep, IndexStep, IoStep, PageRankVertexProgramStep, PeerPressureVertexProgramStep, PropertiesStep, PropertyMapStep, ShortestPathVertexProgramStep, TinkerGraphStep, TraversalFilterStep, VertexStep, VertexStepPlaceholder
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. This interface should not be used to store step data which is unrelated to the GraphTraversal.with(String, Object) step modulator.
Author:
Stephen Mallette (http://stephen.genoprime.com)

  • Method Summary

    Modifier and Type
    Method
    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 Details

    • 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).