Package de.bsommerfeld.pathetic.engine.result

Class PathfinderResultImpl

java.lang.Object

de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl

All Implemented Interfaces:

PathfinderResult

public class PathfinderResultImpl
extends Object
implements PathfinderResult

Constructor Summary

Constructors

Constructor	Description
PathfinderResultImpl(PathState pathState, Path path)

Method Summary

Modifier and Type	Method	Description
Path	getPath()	Returns the found Path regardless if successful or not.
PathState	getPathState()	Returns the state of the pathfinding.
boolean	hasFailed()	Whether the pathfinder has failed to reach its target.
boolean	hasFallenBack()	Whether a pathfinder has resulted in a fallback.
boolean	successful()	Returns whether the pathfinding was successful.

Methods inherited from class java.lang.Object

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

Constructor Details

PathfinderResultImpl

public PathfinderResultImpl(PathState pathState,
 Path path)

Method Details

successful

public boolean successful()

Description copied from interface: PathfinderResult

Returns whether the pathfinding was successful.

Specified by:

successful in interface PathfinderResult

Returns:

true if the pathfinding was successful

hasFailed

public boolean hasFailed()

Description copied from interface: PathfinderResult

Whether the pathfinder has failed to reach its target. This includes PathState.FAILED, PathState.LENGTH_LIMITED, PathState.MAX_ITERATIONS_REACHED and PathState.FALLBACK

Specified by:

hasFailed in interface PathfinderResult

Returns:

Whether the pathfinder has failed to reach its target

hasFallenBack

public boolean hasFallenBack()

Description copied from interface: PathfinderResult

Whether a pathfinder has resulted in a fallback.

Specified by:

hasFallenBack in interface PathfinderResult

Returns:

Whether a pathfinder has resulted in a fallback

getPathState

public PathState getPathState()

Description copied from interface: PathfinderResult

Returns the state of the pathfinding.

Specified by:

getPathState in interface PathfinderResult

Returns:

The PathState

getPath

public Path getPath()

Description copied from interface: PathfinderResult

Returns the found Path regardless if successful or not. The path is empty if the pathfinding failed.

Specified by:

getPath in interface PathfinderResult

Returns:

The found Path