ch.awae.utils.pathfinding

Interface Pathfinder<V>

Type Parameters:

V - the vertex type supported by the pathfinder

All Known Implementing Classes:

AStarPathfinder, DijkstraPathfinder, VertexPathfinder

public interface Pathfinder<V>

Base Interface for pathfinding algorithm implementations

Since:

awaeUtils 1.0.0

Author:

Andreas Wälchli

Method Summary

Modifier and Type	Method and Description
PathfindingResult<V>	execute(V from, V to)
default java.util.List<V>	findPath(V from, V to) Finds a path for the given starting point and the given destination
default long	getTimeout() gets the currently set timeout value or 0 if timeouts are disabled.
default void	setTimeout(long timeout) set a timeout for the pathfinding.

Method Detail

findPath

default java.util.List<V> findPath(V from,
                                   V to)

Finds a path for the given starting point and the given destination

Parameters:

from - the starting vertex

to - the destination vertex

Returns:

an ordered list containing the path

execute

PathfindingResult<V> execute(V from,
                             V to)

setTimeout

default void setTimeout(long timeout)

set a timeout for the pathfinding. when the timeout has been exceeded the pathfinder implementation must terminate and return null. By default timeouts are not supported and an UnsupportedOperationException is thrown.

Parameters:

timeout - the timeout in milliseconds. A value of 0 or less disables timeout.

getTimeout

default long getTimeout()

gets the currently set timeout value or 0 if timeouts are disabled. By default timeouts are not supported and an UnsupportedOperationException is thrown.

Returns:

the current timeout in milliseconds.