Enum Class GuideBook.PageTurn

java.lang.Object

java.lang.Enum<GuideBook.PageTurn>

net.ixdarklord.folios.api.client.GuideBook.PageTurn

All Implemented Interfaces:

Serializable, Comparable<GuideBook.PageTurn>, Constable

Enclosing class:

GuideBook

public static enum GuideBook.PageTurn
extends Enum<GuideBook.PageTurn>

How a handheld book's leaves turn ("page_turn" in book.json).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BEND	A leaf that bends as it goes, its free edge trailing as it lifts and following as it lands.
FLAT	A stiff leaf swinging over the spine.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FLAT

public static final GuideBook.PageTurn FLAT

A stiff leaf swinging over the spine.

BEND

public static final GuideBook.PageTurn BEND

A leaf that bends as it goes, its free edge trailing as it lifts and following as it lands.

Method Details

values

public static GuideBook.PageTurn[] 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 GuideBook.PageTurn 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