io.github.nucleuspowered.nucleus.api.teleport.data

Enum TeleportResult

java.lang.Object

java.lang.Enum<TeleportResult>

io.github.nucleuspowered.nucleus.api.teleport.data.TeleportResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TeleportResult>

public enum TeleportResult
extends java.lang.Enum<TeleportResult>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL_CANCELLED
FAIL_NO_LOCATION
SUCCESS

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final TeleportResult SUCCESS

FAIL_NO_LOCATION

public static final TeleportResult FAIL_NO_LOCATION

FAIL_CANCELLED

public static final TeleportResult FAIL_CANCELLED

Method Detail

values

public static TeleportResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TeleportResult c : TeleportResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static TeleportResult valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isSuccessful

public boolean isSuccessful()