oracle.pgx.api

Class AllPaths<ID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.Destroyable

oracle.pgx.api.AllPaths<ID>

Type Parameters:

ID - the vertex ID type

All Implemented Interfaces:

java.lang.AutoCloseable

public class AllPaths<ID>
extends Destroyable

The paths from one source vertex to all other vertices.

Method Summary

Modifier and Type	Method and Description
PgxFuture<java.lang.Void>	destroyAsync() Requests destruction of this object.
PgxGraph	getGraph() Gets the graph.
PgxPath<ID>	getPath(PgxVertex<ID> destination) Gets the path.
PgxVertex<ID>	getSource() Gets the source vertex
java.lang.String	toString()

Methods inherited from class oracle.pgx.api.Destroyable

close, destroy

Methods inherited from class java.lang.Object

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

Method Detail

destroyAsync

public PgxFuture<java.lang.Void> destroyAsync()

Description copied from class: Destroyable

Requests destruction of this object. After this method returns, the behavior of any method of this class becomes undefined.

Specified by:

destroyAsync in class Destroyable

Returns:

a future which will be completed once the destruction request finishes.

getGraph

public PgxGraph getGraph()

Gets the graph.

Returns:

the graph

getPath

public PgxPath<ID> getPath(PgxVertex<ID> destination)

Gets the path.

Parameters:

destination - the destination node

Returns:

the path result to the destination node

getSource

public PgxVertex<ID> getSource()

Gets the source vertex

Returns:

the source vertex

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object