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<Event.ElementPropertyChangedEvent>

public final class AddPropertyStep<S extends Element>
extends SideEffectStep<S>
implements Mutating<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, labels, 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
VertexProperty.Cardinality	getCardinality()
String	getKey()
CallbackRegistry<Event.ElementPropertyChangedEvent>	getMutatingCallbackRegistry() Gets the callback registry for events that the step raises.
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
Object	getValue()
Object[]	getVertexPropertyKeyValues()
int	hashCode()
boolean	isAsVertex()
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

addLabel, addStart, addStarts, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

equals

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

getCardinality

public VertexProperty.Cardinality getCardinality()

getKey

public String getKey()

getValue

public Object getValue()

getVertexPropertyKeyValues

public Object[] getVertexPropertyKeyValues()

isAsVertex

public boolean isAsVertex()

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

getMutatingCallbackRegistry

public CallbackRegistry<Event.ElementPropertyChangedEvent> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<Event.ElementPropertyChangedEvent>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S extends Element,S extends Element>