All Superinterfaces:: net.kyori.adventure.inventory.BookLike, Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder, PersistentDataViewHolder, WritableBookMeta

public interface BookMeta extends WritableBookMeta

Represents a Material.WRITTEN_BOOK that can have a title, an author, and pages.

Before using this type, make sure to check the itemstack's material with ItemStack.getType(). instanceof on the meta instance is not sufficient due to unusual inheritance with relation to WritableBookMeta.

Since:: 1.4.5

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

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)

Deprecated.
use addPages(net.kyori.adventure.text.Component...)

void

addPages(@NotNull net.kyori.adventure.text.Component @NotNull ... pages)

Adds new pages to the end of the book.

@Nullable net.kyori.adventure.text.Component

author()

Gets the author of the book.

@NotNull BookMeta

author(@Nullable net.kyori.adventure.text.Component author)

Sets the author 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)

Deprecated.
use page(int)

@NotNull List<String>

getPages()

Deprecated.
use pages()

@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

hasTitle()

Checks for the existence of a title in the book.

@NotNull net.kyori.adventure.text.Component

page(int page)

Gets the specified page in the book.

void

page(int page, @NotNull net.kyori.adventure.text.Component data)

Sets the specified page in the book.

@NotNull List<net.kyori.adventure.text.Component>

pages()

Gets the list of pages.

@NotNull BookMeta

pages(@NotNull List<net.kyori.adventure.text.Component> pages)

Sets the pages of the book.

default @NotNull BookMeta

pages(@NotNull net.kyori.adventure.text.Component @NotNull ... pages)

Sets the pages of 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)

Deprecated.
use page(int, net.kyori.adventure.text.Component)

void

setPages(@NotNull String... pages)

Deprecated.
use pages(net.kyori.adventure.text.Component...)

void

setPages(@NotNull List<String> pages)

Deprecated.
use pages(List)

boolean

setTitle(@Nullable String title)

Sets the title of the book.

@NotNull BookMeta.Spigot

spigot()

@Nullable net.kyori.adventure.text.Component

title()

Gets the title of the book.

@NotNull BookMeta

title(@Nullable net.kyori.adventure.text.Component title)

Sets the title of the book.

Methods inherited from interface net.kyori.adventure.inventory.BookLike
asBook

Methods inherited from interface ConfigurationSerializable
serialize

Methods inherited from interface ItemMeta
addAttributeModifier, addEnchant, addItemFlags, customName, customName, displayName, displayName, getAsComponentString, getAsString, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCanDestroy, getCanPlaceOn, getCustomModelData, getCustomModelDataComponent, getCustomTagContainer, getDamageResistant, getDamageResistantTypes, getDestroyableKeys, getDisplayName, getDisplayNameComponent, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippable, getFood, getItemFlags, getItemModel, getItemName, getJukeboxPlayable, getLocalizedName, getLore, getLoreComponents, getMaxStackSize, getPlaceableKeys, getRarity, getTool, getTooltipStyle, getUseCooldown, getUseRemainder, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasCustomModelDataComponent, hasCustomName, hasDamageResistant, hasDestroyableKeys, hasDisplayName, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippable, hasFood, hasItemFlag, hasItemModel, hasItemName, hasJukeboxPlayable, hasLocalizedName, hasLore, hasMaxStackSize, hasPlaceableKeys, hasRarity, hasTool, hasTooltipStyle, hasUseCooldown, hasUseRemainder, isFireResistant, isGlider, isHideTooltip, isUnbreakable, itemName, itemName, lore, lore, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchantments, removeItemFlags, setAttributeModifiers, setCanDestroy, setCanPlaceOn, setCustomModelData, setCustomModelDataComponent, setDamageResistant, setDamageResistantTypes, setDestroyableKeys, setDisplayName, setDisplayNameComponent, setEnchantable, setEnchantmentGlintOverride, setEquippable, setFireResistant, setFood, setGlider, setHideTooltip, setItemModel, setItemName, setJukeboxPlayable, setLocalizedName, setLore, setLoreComponents, setMaxStackSize, setPlaceableKeys, setRarity, setTool, setTooltipStyle, setUnbreakable, setUseCooldown, setUseRemainder, setVersion

Methods inherited from interface PersistentDataHolder
getPersistentDataContainer

Methods inherited from interface WritableBookMeta
getPageCount, hasPages

Method Details
- hasTitle
  
  boolean hasTitle()
  
  Checks for the existence of a title in the book.
  
  Returns:
  
  true if the book has a title
  
  Since:
  
  1.4.5
- 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
  
  Since:
  
  1.4.5
- 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
  
  Since:
  
  1.4.5
- hasAuthor
  
  boolean hasAuthor()
  
  Checks for the existence of an author in the book.
  
  Returns:
  
  true if the book has an author
  
  Since:
  
  1.4.5
- 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
  
  Since:
  
  1.4.5
- setAuthor
  
  void setAuthor(@Nullable @Nullable String author)
  
  Sets the author of the book. Removes author when given null.
  
  Parameters:
  
  author - the author to set
  
  Since:
  
  1.4.5
- hasGeneration
  
  boolean hasGeneration()
  
  Checks for the existence of generation level in the book.
  
  Returns:
  
  true if the book has a generation level
  
  Since:
  
  1.10.2
- 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
  
  Since:
  
  1.9.4
- 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
  
  Since:
  
  1.9.4
- clone
  
  @NotNull @NotNull BookMeta clone()
  
  Specified by:
  
  clone in interface ItemMeta
  
  Specified by:
  
  clone in interface WritableBookMeta
- getPage
  
  @Deprecated @NotNull @NotNull String getPage(int page)
  
  Deprecated.
  use page(int)
  
  Description copied from interface: WritableBookMeta
  
  Gets the specified page in the book. The given page must exist.
  Pages are 1-indexed.
  
  Specified by:
  
  getPage in interface WritableBookMeta
  
  Parameters:
  
  page - the page number to get, in range [1, getPageCount()]
  
  Returns:
  
  the page from the book
  
  Since:
  
  1.4.5
- setPage
  
  @Deprecated void setPage(int page, @NotNull @NotNull String data)
  
  Deprecated.
  use page(int, net.kyori.adventure.text.Component)
  
  Description copied from interface: WritableBookMeta
  
  Sets the specified page in the book. Pages of the book must be contiguous.
  The data can be up to 1024 characters in length, additional characters are truncated.
  Pages are 1-indexed.
  
  Specified by:
  
  setPage in interface WritableBookMeta
  
  Parameters:
  
  page - the page number to set, in range [1, getPageCount()]
  
  data - the data to set for that page
  
  Since:
  
  1.4.5
- getPages
  
  @Deprecated @NotNull @NotNull List<String> getPages()
  
  Deprecated.
  use pages()
  
  Description copied from interface: WritableBookMeta
  
  Gets all the pages in the book.
  
  Specified by:
  
  getPages in interface WritableBookMeta
  
  Returns:
  
  list of all the pages in the book
  
  Since:
  
  1.4.5
- setPages
  
  @Deprecated void setPages(@NotNull @NotNull List<String> pages)
  
  Deprecated.
  use pages(List)
  
  Description copied from interface: WritableBookMeta
  
  Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 1024 characters per page.
  
  Specified by:
  
  setPages in interface WritableBookMeta
  
  Parameters:
  
  pages - A list of pages to set the book to use
  
  Since:
  
  1.4.5
- setPages
  
  @Deprecated void setPages(@NotNull @NotNull String... pages)
  
  Deprecated.
  use pages(net.kyori.adventure.text.Component...)
  
  Description copied from interface: WritableBookMeta
  
  Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 1024 characters per page.
  
  Specified by:
  
  setPages in interface WritableBookMeta
  
  Parameters:
  
  pages - A list of strings, each being a page
  
  Since:
  
  1.4.5
- addPage
  
  @Deprecated void addPage(@NotNull @NotNull String... pages)
  
  Deprecated.
  use addPages(net.kyori.adventure.text.Component...)
  
  Description copied from interface: WritableBookMeta
  
  Adds new pages to the end of the book. Up to a maximum of 100 pages with 1024 characters per page.
  
  Specified by:
  
  addPage in interface WritableBookMeta
  
  Parameters:
  
  pages - A list of strings, each being a page
  
  Since:
  
  1.4.5
- title
  
  @Nullable net.kyori.adventure.text.Component title()
  
  Gets the title of the book.
  Plugins should check that hasTitle() returns true before calling this method.
  
  Returns:
  
  the title of the book
  
  Since:
  
  1.16.5
- title
  
  @Contract("_ -> this") @NotNull @NotNull BookMeta title(@Nullable net.kyori.adventure.text.Component title)
  
  Sets the title of the book.
  Limited to 32 characters. Removes title when given null.
  
  Parameters:
  
  title - the title to set
  
  Returns:
  
  the same BookMeta instance
  
  Since:
  
  1.16.5
- author
  
  @Nullable net.kyori.adventure.text.Component author()
  
  Gets the author of the book.
  Plugins should check that hasAuthor() returns true before calling this method.
  
  Returns:
  
  the author of the book
  
  Since:
  
  1.16.5
- author
  
  @Contract("_ -> this") @NotNull @NotNull BookMeta author(@Nullable net.kyori.adventure.text.Component author)
  
  Sets the author of the book. Removes author when given null.
  
  Parameters:
  
  author - the author to set
  
  Returns:
  
  the same BookMeta instance
  
  Since:
  
  1.16.5
- page
  
  @NotNull net.kyori.adventure.text.Component page(int page)
  
  Gets the specified page in the book. The page must exist.
  Pages are 1-indexed.
  
  Parameters:
  
  page - the page number to get, in range [1, getPageCount()]
  
  Returns:
  
  the page from the book
  
  Since:
  
  1.16.5
- page
  
  void page(int page, @NotNull net.kyori.adventure.text.Component data)
  
  Sets the specified page in the book. Pages of the book must be contiguous.
  The data can be up to 1024 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
  
  Since:
  
  1.16.5
- addPages
  
  void addPages(@NotNull net.kyori.adventure.text.Component @NotNull ... pages)
  
  Adds new pages to the end of the book. Up to a maximum of 100 pages with 1024 characters per page.
  
  Parameters:
  
  pages - A list of strings, each being a page
  
  Since:
  
  1.16.5
- pages
  
  @NotNull @NotNull List<net.kyori.adventure.text.Component> pages()
  
  Gets the list of pages.
  The returned collection will be unmodifiable.
  
  Returns:
  
  the list of pages
  
  Since:
  
  26.2
- pages
  
  @Contract("_ -> this") @NotNull @NotNull BookMeta pages(@NotNull @NotNull List<net.kyori.adventure.text.Component> pages)
  
  Sets the pages of the book.
  
  Parameters:
  
  pages - the pages to set
  
  Returns:
  
  this book instance
  
  Since:
  
  26.2
- pages
  
  @Contract("_ -> this") @NotNull default @NotNull BookMeta pages(@NotNull @NotNull net.kyori.adventure.text.Component @NotNull ... pages)
  
  Sets the pages of the book.
  
  Parameters:
  
  pages - the pages to set
  
  Returns:
  
  this book instance
  
  Since:
  
  26.2
- spigot
  
  @NotNull @NotNull BookMeta.Spigot spigot()
  
  Since:
  
  1.12.2

Interface BookMeta

Nested Class Summary

Method Summary

Methods inherited from interface net.kyori.adventure.inventory.BookLike

Methods inherited from interface ConfigurationSerializable

Methods inherited from interface ItemMeta

Methods inherited from interface PersistentDataHolder

Methods inherited from interface WritableBookMeta

Method Details

hasTitle

getTitle

setTitle

hasAuthor

getAuthor

setAuthor

hasGeneration

getGeneration

setGeneration

clone

getPage

setPage

getPages

setPages

setPages

addPage

title

title

author

author

page

page

addPages

pages

pages

pages

spigot