Package net.ixdarklord.folios.api.client

Enum Class FoliosBook.Progress

java.lang.Object

java.lang.Enum<FoliosBook.Progress>

net.ixdarklord.folios.api.client.FoliosBook.Progress

All Implemented Interfaces:

Serializable, Comparable<FoliosBook.Progress>, Constable

Enclosing class:

FoliosBook

public static enum FoliosBook.Progress
extends Enum<FoliosBook.Progress>

Where what is read in a book is kept ("progress" in book.json): the entries read, the pages shown, the bookmarks and where the reader left off.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOK	On each copy of the book, like a notebook's: whoever reads that copy finds its bookmarks and read pages, and a new copy starts fresh.
PLAYER	With each player, on the server: theirs in any copy of the book, from any computer.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLAYER

public static final FoliosBook.Progress PLAYER

With each player, on the server: theirs in any copy of the book, from any computer.

BOOK

public static final FoliosBook.Progress BOOK

On each copy of the book, like a notebook's: whoever reads that copy finds its bookmarks and read pages, and a new copy starts fresh. Read pages still count for the player too (quests, celebrations). A book opened without a copy in hand (by a command or from code) uses the player's.

Method Details

values

public static FoliosBook.Progress[] 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 FoliosBook.Progress 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