Package fr.multimc.api.spigot.common.tools.builders.items

Class BookBuilder

java.lang.Object

fr.multimc.api.spigot.common.tools.builders.items.ItemBuilder

fr.multimc.api.spigot.common.tools.builders.items.BookBuilder

public class BookBuilder
extends ItemBuilder

Create easily a book.

Since:

04/10/2022

Constructor Summary

Constructors

Constructor	Description
BookBuilder()	Create an instance of BookBuilder based on the ItemBuilder.
BookBuilder(int amount)	Create an instance of BookBuilder based on the ItemBuilder with a custom amount.
BookBuilder(@NotNull org.bukkit.inventory.ItemStack item)	Create an instance of BookBuilder based on the ItemBuilder with an existing item.

Method Summary

Modifier and Type	Method	Description
BookBuilder	addPage(@NotNull String page)	Deprecated.
BookBuilder	addPages(@NotNull String... pages)	Deprecated.
BookBuilder	setAuthor(@Nullable String author)	Set the book author name.
BookBuilder	setGeneration(org.bukkit.inventory.meta.BookMeta.Generation generation)	Set the book generation.
BookBuilder	setTitle(@Nullable String title)	Set the book title.

Methods inherited from class fr.multimc.api.spigot.common.tools.builders.items.ItemBuilder

addEnchantment, addEnchantments, addFlags, applyMeta, build, getMeta, removeAllEnchantments, removeEnchantment, removeEnchantments, removeEnchantments, removeFlags, setCustomModelData, setLegacyLore, setLegacyLore, setLegacyName, setLore, setLore, setName, setUnbreakable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BookBuilder

public BookBuilder()

Create an instance of BookBuilder based on the ItemBuilder.

BookBuilder

public BookBuilder(@NotNull
 @NotNull org.bukkit.inventory.ItemStack item)

Create an instance of BookBuilder based on the ItemBuilder with an existing item.

Parameters:

item - Item.

BookBuilder

public BookBuilder(int amount)

Create an instance of BookBuilder based on the ItemBuilder with a custom amount.

Parameters:

amount - Amount.

Method Details

setAuthor

public BookBuilder setAuthor(@Nullable
 @Nullable String author)

Set the book author name.

Parameters:

author - Author name.

Returns:

Current instance of the builder.

addPages

@Deprecated
public BookBuilder addPages(@NotNull
 @NotNull String... pages)

Deprecated.

Add pages to the book.

Parameters:

pages - Pages.

Returns:

Current instance of the builder.

addPage

@Deprecated
public BookBuilder addPage(@NotNull
 @NotNull String page)

Deprecated.

Add pages to the book.

Parameters:

page - Pages.

Returns:

Current instance of the builder.

setGeneration

public BookBuilder setGeneration(@Nullable
 org.bukkit.inventory.meta.BookMeta.Generation generation)

Set the book generation.

Parameters:

generation - Generation.

Returns:

Current instance of the builder.

setTitle

public BookBuilder setTitle(@Nullable
 @Nullable String title)

Set the book title.

Parameters:

title - Title.

Returns:

Current instance of the builder.