Enum Class WalkResult

java.lang.Object

java.lang.Enum<WalkResult>

com.botwithus.bot.api.model.WalkResult

All Implemented Interfaces:

Serializable, Comparable<WalkResult>, Constable

public enum WalkResult
extends Enum<WalkResult>

Result of a blocking walk operation.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRIVED	The walker reached the destination.
CANCELLED	The walk was cancelled (by another action or explicit cancel).
FAILED	The walk failed (pathfinding failure, stuck, etc.).
TIMEOUT	The walk timed out waiting for a result.

Method Summary

Modifier and Type	Method	Description
static WalkResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WalkResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARRIVED

public static final WalkResult ARRIVED

The walker reached the destination.

CANCELLED

public static final WalkResult CANCELLED

The walk was cancelled (by another action or explicit cancel).

FAILED

public static final WalkResult FAILED

The walk failed (pathfinding failure, stuck, etc.).

TIMEOUT

public static final WalkResult TIMEOUT

The walk timed out waiting for a result.

Method Details

values

public static WalkResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static WalkResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null