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

Class SparsePath

java.lang.Object

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

All Implemented Interfaces:

Serializable, Cloneable, Path

public class SparsePath
extends Object
implements Path, Serializable

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	SparsePath()

Method Summary

Modifier and Type	Method and Description
void	addLabel(String label) Add label to the current head of the path.
Path	clone()
Path	extend(Object object, String... labels) Add a new step to the path with an object and any number of associated labels.
<A> A	get(String label) Get the object 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
static SparsePath	make()
List<Object>	objects() An ordered list of the objects in the path.
int	size() Get the number of step in the path.

Methods inherited from class java.lang.Object

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

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

forEach, forEach, get, isSimple, stream

Constructor Detail

SparsePath

protected SparsePath()

Method Detail

make

public static SparsePath make()

extend

public Path extend(Object object,
                   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

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

Specified by:

labels in interface Path

Returns:

the labels of the path

get

public <A> A get(String label)
          throws IllegalArgumentException

Description copied from interface: Path

Get the object associated with the particular label of the path. If the path as multiple labels of the type, then return a List of those objects.

Specified by:

get in interface 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

Throws:

IllegalArgumentException - if the path does not contain the label

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

clone

public Path clone()

Description copied from interface: Path

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