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

Class AddPropertyStep<S extends Element>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AddPropertyStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<S>>, Step<S,S>, Mutating<EventCallback<Event.ElementPropertyChangedEvent>>

public final class AddPropertyStep<S extends Element>
extends SideEffectStep<S>
implements Mutating<EventCallback<Event.ElementPropertyChangedEvent>>

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, label, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
AddPropertyStep(Traversal.Admin traversal, String key, Object value, Object... vertexPropertyKeyValues)
AddPropertyStep(Traversal.Admin traversal, VertexProperty.Cardinality cardinality, String key, Object value, Object... vertexPropertyKeyValues)

Method Summary

Modifier and Type	Method and Description
void	addCallback(EventCallback<Event.ElementPropertyChangedEvent> elementPropertyChangedEventCallback)
void	clearCallbacks()
List<EventCallback<Event.ElementPropertyChangedEvent>>	getCallbacks()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
void	removeCallback(EventCallback<Event.ElementPropertyChangedEvent> elementPropertyChangedEventCallback)
protected void	sideEffect(Traverser.Admin<S> traverser)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep

processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addStart, addStarts, clone, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, reset, setId, setLabel, setNextStep, setPreviousStep, setTraversal, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

AddPropertyStep

public AddPropertyStep(Traversal.Admin traversal,
                       VertexProperty.Cardinality cardinality,
                       String key,
                       Object value,
                       Object... vertexPropertyKeyValues)

AddPropertyStep

public AddPropertyStep(Traversal.Admin traversal,
                       String key,
                       Object value,
                       Object... vertexPropertyKeyValues)

Method Detail

sideEffect

protected void sideEffect(Traverser.Admin<S> traverser)

Specified by:

sideEffect in class SideEffectStep<S extends Element>

getRequirements

public Set<TraverserRequirement> getRequirements()

Description copied from interface: Step

Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.

Specified by:

getRequirements in interface Step<S extends Element,S extends Element>

Returns:

the set of requirements

addCallback

public void addCallback(EventCallback<Event.ElementPropertyChangedEvent> elementPropertyChangedEventCallback)

Specified by:

addCallback in interface Mutating<EventCallback<Event.ElementPropertyChangedEvent>>

removeCallback

public void removeCallback(EventCallback<Event.ElementPropertyChangedEvent> elementPropertyChangedEventCallback)

Specified by:

removeCallback in interface Mutating<EventCallback<Event.ElementPropertyChangedEvent>>

clearCallbacks

public void clearCallbacks()

Specified by:

clearCallbacks in interface Mutating<EventCallback<Event.ElementPropertyChangedEvent>>

getCallbacks

public List<EventCallback<Event.ElementPropertyChangedEvent>> getCallbacks()

Specified by:

getCallbacks in interface Mutating<EventCallback<Event.ElementPropertyChangedEvent>>