io.github.mainstringargs.alpaca.enums

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

io.github.mainstringargs.alpaca.enums.Direction

All Implemented Interfaces:

APIName, java.io.Serializable, java.lang.Comparable<Direction>

public enum Direction
extends java.lang.Enum<Direction>
implements APIName

The Enum Direction.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING The asc.
DESCENDING The desc.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAPIName() Gets the API name.
static Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

ASCENDING

public static final Direction ASCENDING

The asc.

DESCENDING

public static final Direction DESCENDING

The desc.

Method Detail

values

public static Direction[] 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 (Direction c : Direction.values())
    System.out.println(c);

Returns:

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

valueOf

public static Direction 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

getAPIName

public java.lang.String getAPIName()

Description copied from interface: APIName

Gets the API name.

Specified by:

getAPIName in interface APIName

Returns:

the API name