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

Interface AddPropertyStepContract<S>

All Superinterfaces:

AutoCloseable, Cloneable, Configuring, Deleting<Event.ElementPropertyChangedEvent>, Iterator<Traverser.Admin<S>>, Mutating<Event.ElementPropertyChangedEvent>, Parameterizing, PopContaining, PropertiesHolder, Scoping, Serializable, Step<S,S>, TraversalParent, Writing<Event.ElementPropertyChangedEvent>

All Known Implementing Classes:

AddPropertyStep, AddPropertyStepPlaceholder

public interface AddPropertyStepContract<S>
extends Step<S,S>, TraversalParent, Scoping, PropertiesHolder, Writing<Event.ElementPropertyChangedEvent>, Deleting<Event.ElementPropertyChangedEvent>, Configuring

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PopContaining

PopContaining.PopInstruction

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping

Scoping.KeyNotFoundException, Scoping.Variable

Field Summary

Fields

Modifier and Type	Field	Description
static List<Class<? extends Step>>	CONCRETE_STEPS	Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Summary

Modifier and Type	Method	Description
VertexProperty.Cardinality	getCardinality()
Object	getKey()	Get the property key
default HashSet<PopContaining.PopInstruction>	getPopInstructions()	Used to get PopInstruction of a Step that implements Scoping.
Object	getValue()	Gets the property value.
default Object	getValueWithGValue()	Gets the property value.

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

configure

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

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

getMutatingCallbackRegistry

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

getParameters

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

addProperty, getProperties, getPropertiesWithGValues, removeProperty

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

getNullableScopeValue, getSafeScopeValue, getScopeKeys, getScopeValue

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

addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getRequirements, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

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

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getLocalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

Field Detail

CONCRETE_STEPS

static final List<Class<? extends Step>> CONCRETE_STEPS

Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Detail

getCardinality

VertexProperty.Cardinality getCardinality()

getPopInstructions

default HashSet<PopContaining.PopInstruction> getPopInstructions()

Description copied from interface: Scoping

Used to get PopInstruction of a Step that implements Scoping. PopInstruction includes the labels it needs, and the pop type for each label.

Specified by:

getPopInstructions in interface PopContaining

Specified by:

getPopInstructions in interface Scoping

Specified by:

getPopInstructions in interface TraversalParent

Returns:

A Set of PopContaining.PopInstruction values which contain the label and Pop value

getKey

Object getKey()

Get the property key

getValue

Object getValue()

Gets the property value. If the value was originally passed as a GValue, the variable will become pinned and the literal value returned.

getValueWithGValue

default Object getValueWithGValue()

Gets the property value. If the value was originally passed as a GValue it is returned as-is, without pinning the variable.