redis.clients.jedis.graph.entities

Class Path

java.lang.Object

redis.clients.jedis.graph.entities.Path

public final class Path
extends Object

This class represents a path in the graph.

Constructor Summary

Constructors

Constructor and Description
Path(List<Node> nodes, List<Edge> edges) Parametrized constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Node	firstNode() Returns the first node in the path.
Edge	getEdge(int index) Returns an edge with specified index in the path.
List<Edge>	getEdges() Returns the edges of the path.
Node	getNode(int index) Returns a node with specified index in the path.
List<Node>	getNodes() Returns the nodes of the path.
int	hashCode()
Node	lastNode() Returns the last node in the path.
int	length() Returns the length of the path - number of edges.
int	nodeCount() Return the number of nodes in the path.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path(List<Node> nodes,
            List<Edge> edges)

Parametrized constructor

Parameters:

nodes - - List of nodes.

edges - - List of edges.

Method Detail

getNodes

public List<Node> getNodes()

Returns the nodes of the path.

Returns:

List of nodes.

getEdges

public List<Edge> getEdges()

Returns the edges of the path.

Returns:

List of edges.

length

public int length()

Returns the length of the path - number of edges.

Returns:

Number of edges.

nodeCount

public int nodeCount()

Return the number of nodes in the path.

Returns:

Number of nodes.

firstNode

public Node firstNode()

Returns the first node in the path.

Returns:

First nodes in the path.

Throws:

IndexOutOfBoundsException - if the path is empty.

lastNode

public Node lastNode()

Returns the last node in the path.

Returns:

Last nodes in the path.

Throws:

IndexOutOfBoundsException - if the path is empty.

getNode

public Node getNode(int index)

Returns a node with specified index in the path.

Returns:

Node.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= nodesCount())

getEdge

public Edge getEdge(int index)

Returns an edge with specified index in the path.

Returns:

Edge.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= length())

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object