org.spongepowered.api.text

Class BookView

java.lang.Object

org.spongepowered.api.text.BookView

All Implemented Interfaces:

DataSerializable

public final class BookView
extends Object
implements DataSerializable

Represents a view of the Book GUI on the client. A BookView is not associated with any Book ItemStack that exists on the server and is simply for displaying Text to the player. This BookView is read-only as it is currently impossible to tell the client to open an unsigned book.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BookView.Builder Builder class to assist in creation of a new BookView.

Method Summary

Modifier and Type	Method and Description
static BookView.Builder	builder() Returns a new BookView.Builder for chaining.
boolean	equals(Object obj)
Text	getAuthor() Returns the author of the book to be displayed.
int	getContentVersion() Gets the content version of this DataSerializable.
ImmutableList<Text>	getPages() Returns a list of pages that will be displayed to the client.
Text	getTitle() Returns the title of the book to be displayed.
int	hashCode()
DataContainer	toContainer() Serializes this object into a comprehensible DataContainer.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTitle

public Text getTitle()

Returns the title of the book to be displayed.

Returns:

Title of book

getAuthor

public Text getAuthor()

Returns the author of the book to be displayed.

Returns:

Author of book

getPages

public ImmutableList<Text> getPages()

Returns a list of pages that will be displayed to the client.

Returns:

List of pages in book

builder

public static BookView.Builder builder()

Returns a new BookView.Builder for chaining.

Returns:

Builder for chaining

getContentVersion

public int getContentVersion()

Description copied from interface: DataSerializable

Gets the content version of this DataSerializable. The version may differ between instances of plugins and implementations such that the DataView from DataSerializable.toContainer() may include different information, or remove other information as they are no longer deemed necessary. The version goes hand in hand with DataContentUpdater as it is required when there exists any DataView of this DataSerializable with an "older" version.

Specified by:

getContentVersion in interface DataSerializable

Returns:

The version of the content being serialized

toContainer

public DataContainer toContainer()

Description copied from interface: DataSerializable

Serializes this object into a comprehensible DataContainer.

Specified by:

toContainer in interface DataSerializable

Returns:

A newly created DataContainer

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object