Package org.bukkit.inventory.meta

Interface BookMeta

All Superinterfaces:

Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder

public interface BookMeta
extends ItemMeta

Represents a book (Material.WRITABLE_BOOK or Material.WRITTEN_BOOK) that can have a title, an author, and pages.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BookMeta.Generation	Represents the generation (or level of copying) of a written book
static class	BookMeta.Spigot

Method Summary

Modifier and Type	Method	Description
void	addPage(@NotNull String... pages)	Adds new pages to the end of the book.
@NotNull BookMeta	clone()
@Nullable String	getAuthor()	Gets the author of the book.
@Nullable BookMeta.Generation	getGeneration()	Gets the generation of the book.
@NotNull String	getPage(int page)	Gets the specified page in the book.
int	getPageCount()	Gets the number of pages in the book.
@NotNull List<String>	getPages()	Gets all the pages in the book.
@Nullable String	getTitle()	Gets the title of the book.
boolean	hasAuthor()	Checks for the existence of an author in the book.
boolean	hasGeneration()	Checks for the existence of generation level in the book.
boolean	hasPages()	Checks for the existence of pages in the book.
boolean	hasTitle()	Checks for the existence of a title in the book.
void	setAuthor(@Nullable String author)	Sets the author of the book.
void	setGeneration(@Nullable BookMeta.Generation generation)	Sets the generation of the book.
void	setPage(int page, @NotNull String data)	Sets the specified page in the book.
void	setPages(@NotNull String... pages)	Clears the existing book pages, and sets the book to use the provided pages.
void	setPages(@NotNull List<String> pages)	Clears the existing book pages, and sets the book to use the provided pages.
boolean	setTitle(@Nullable String title)	Sets the title of the book.
@NotNull BookMeta.Spigot	spigot()

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Methods inherited from interface org.bukkit.inventory.meta.ItemMeta

addAttributeModifier, addEnchant, addItemFlags, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCustomModelData, getCustomTagContainer, getDisplayName, getEnchantLevel, getEnchants, getItemFlags, getLocalizedName, getLore, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasDisplayName, hasEnchant, hasEnchants, hasItemFlag, hasLocalizedName, hasLore, isUnbreakable, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeItemFlags, setAttributeModifiers, setCustomModelData, setDisplayName, setLocalizedName, setLore, setUnbreakable, setVersion

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Method Detail

hasTitle

boolean hasTitle()

Checks for the existence of a title in the book.

Returns:

true if the book has a title

getTitle

@Nullable
@Nullable String getTitle()

Gets the title of the book.

Plugins should check that hasTitle() returns true before calling this method.

Returns:

the title of the book

setTitle

boolean setTitle(@Nullable
                 @Nullable String title)

Sets the title of the book.

Limited to 32 characters. Removes title when given null.

Parameters:

title - the title to set

Returns:

true if the title was successfully set

hasAuthor

boolean hasAuthor()

Checks for the existence of an author in the book.

Returns:

true if the book has an author

getAuthor

@Nullable
@Nullable String getAuthor()

Gets the author of the book.

Plugins should check that hasAuthor() returns true before calling this method.

Returns:

the author of the book

setAuthor

void setAuthor(@Nullable
               @Nullable String author)

Sets the author of the book. Removes author when given null.

Parameters:

author - the author to set

hasGeneration

boolean hasGeneration()

Checks for the existence of generation level in the book.

Returns:

true if the book has a generation level

getGeneration

@Nullable
@Nullable BookMeta.Generation getGeneration()

Gets the generation of the book.

Plugins should check that hasGeneration() returns true before calling this method.

Returns:

the generation of the book

setGeneration

void setGeneration(@Nullable
                   @Nullable BookMeta.Generation generation)

Sets the generation of the book. Removes generation when given null.

Parameters:

generation - the generation to set

hasPages

boolean hasPages()

Checks for the existence of pages in the book.

Returns:

true if the book has pages

getPage

@NotNull
@NotNull String getPage(int page)

Gets the specified page in the book. The given page must exist.

Pages are 1-indexed.

Parameters:

page - the page number to get, in range [1, getPageCount()]

Returns:

the page from the book

setPage

void setPage(int page,
             @NotNull
             @NotNull String data)

Sets the specified page in the book. Pages of the book must be contiguous.

The data can be up to 256 characters in length, additional characters are truncated.

Pages are 1-indexed.

Parameters:

page - the page number to set, in range [1, getPageCount()]

data - the data to set for that page

getPages

@NotNull
@NotNull List<String> getPages()

Gets all the pages in the book.

Returns:

list of all the pages in the book

setPages

void setPages(@NotNull
              @NotNull List<String> pages)

Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 256 characters per page.

Parameters:

pages - A list of pages to set the book to use

setPages

void setPages(@NotNull
              @NotNull String... pages)

Clears the existing book pages, and sets the book to use the provided pages. Maximum 50 pages with 256 characters per page.

Parameters:

pages - A list of strings, each being a page

addPage

void addPage(@NotNull
             @NotNull String... pages)

Adds new pages to the end of the book. Up to a maximum of 50 pages with 256 characters per page.

Parameters:

pages - A list of strings, each being a page

getPageCount

int getPageCount()

Gets the number of pages in the book.

Returns:

the number of pages in the book

clone

@NotNull
@NotNull BookMeta clone()

Specified by:

clone in interface ItemMeta

spigot

@NotNull
@NotNull BookMeta.Spigot spigot()