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

Class ImmutablePath

java.lang.Object

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

All Implemented Interfaces:

Serializable, Cloneable, Path

public class ImmutablePath
extends Object
implements Path, Serializable, Cloneable

Author:

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

See Also:

Serialized Form

Nested Class Summary

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

Path.Exceptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutablePath()

Method Summary

Modifier and Type	Method and Description
void	addLabel(String label) Add label to the current head of the path.
ImmutablePath	clone()
Path	extend(Object object, Set<String> labels) Add a new step to the path with an object and any number of associated labels.
<A> A	get(int index) Get the object associated with the specified index into the path.
<A> A	get(Pop pop, String label) Pop the object(s) associated with the label of the path.
<A> A	getSingleHead(String label) Get the object least recently associated with the particular label of the path.
<A> A	getSingleTail(String label) Get the object most recently associated with the particular label of the path.
boolean	hasLabel(String label) Return true if the path has the specified label, else return false.
List<Set<String>>	labels() An ordered list of the labels associated with the path The set of labels for a particular step are ordered by the order in which Path.addLabel(java.lang.String) was called.
static Path	make()
List<Object>	objects() An ordered list of the objects in the path.
int	size() Get the number of step in the path.
String	toString()

Methods inherited from class java.lang.Object

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

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

extend, forEach, forEach, get, isSimple, stream

Constructor Detail

ImmutablePath

protected ImmutablePath()

Method Detail

make

public static Path make()

clone

public ImmutablePath clone()

Specified by:

clone in interface Path

Overrides:

clone in class Object

size

public int size()

Description copied from interface: Path

Get the number of step in the path.

Specified by:

size in interface Path

Returns:

the size of the path

extend

public Path extend(Object object,
                   Set<String> labels)

Description copied from interface: Path

Add a new step to the path with an object and any number of associated labels.

Specified by:

extend in interface Path

Parameters:

object - the new head of the path

labels - the labels at the head of the path

Returns:

the extended path

get

public <A> A get(int index)

Description copied from interface: Path

Get the object associated with the specified index into the path.

Specified by:

get in interface Path

Type Parameters:

A - the type of the object associated with the index

Parameters:

index - the index of the path

Returns:

the object associated with the index of the path

getSingleHead

public <A> A getSingleHead(String label)

Get the object least recently associated with the particular label of the path.

Type Parameters:

A - the type of the object associated with the label

Parameters:

label - the label of the path

Returns:

the object associated with the label of the path or null if the path does not contain the label

getSingleTail

public <A> A getSingleTail(String label)

Get the object most recently associated with the particular label of the path.

Type Parameters:

A - the type of the object associated with the label

Parameters:

label - the label of the path

Returns:

the object associated with the label of the path or null if the path does not contain the label

get

public <A> A get(Pop pop,
                 String label)

Description copied from interface: Path

Pop the object(s) associated with the label of the path.

Specified by:

get in interface Path

Type Parameters:

A - the type of the object associated with the label

Parameters:

pop - first for least recent, last for most recent, and all for all in a list

label - the label of the path

Returns:

the object associated with the label of the path

hasLabel

public boolean hasLabel(String label)

Description copied from interface: Path

Return true if the path has the specified label, else return false.

Specified by:

hasLabel in interface Path

Parameters:

label - the label to search for

Returns:

true if the label exists in the path

addLabel

public void addLabel(String label)

Description copied from interface: Path

Add label to the current head of the path.

Specified by:

addLabel in interface Path

Parameters:

label - the label to add to the head of the path

objects

public List<Object> objects()

Description copied from interface: Path

An ordered list of the objects in the path.

Specified by:

objects in interface Path

Returns:

the objects of the path

labels

public List<Set<String>> labels()

Description copied from interface: Path

An ordered list of the labels associated with the path The set of labels for a particular step are ordered by the order in which Path.addLabel(java.lang.String) was called.

Specified by:

labels in interface Path

Returns:

the labels of the path

toString

public String toString()

Overrides:

toString in class Object