Package net.kyori.adventure.inventory
Interface Book.Builder
- All Superinterfaces:
Buildable.Builder<Book>
- Enclosing interface:
- Book
public static interface Book.Builder extends Buildable.Builder<Book>
A builder for a
Book
.- Since:
- 4.0.0
-
Method Summary
Modifier and Type Method Description @NotNull Book.Builder
addPage(@NotNull Component page)
Add a page to the book.@NotNull Book.Builder
author(@NotNull Component author)
Set the author.@NotNull Book
build()
Builds.@NotNull Book.Builder
pages(@NotNull Collection<Component> pages)
Add pages to the book.@NotNull Book.Builder
pages(@NotNull Component @NotNull ... pages)
Add pages to the book.@NotNull Book.Builder
title(@NotNull Component title)
Set the title.
-
Method Details
-
title
Set the title.- Parameters:
title
- the title- Returns:
- this
- Since:
- 4.0.0
-
author
Set the author.- Parameters:
author
- the author- Returns:
- this
- Since:
- 4.0.0
-
addPage
Add a page to the book.Each page's length will be limited by the size of the client's book viewer. Any text that does not fit will be truncated clientside.
- Parameters:
page
- the page- Returns:
- this
- Since:
- 4.0.0
-
pages
@Contract("_ -> this") @NotNull @NotNull Book.Builder pages(@NotNull @NotNull Component @NotNull ... pages)Add pages to the book.- Parameters:
pages
- pages to add- Returns:
- this
- Since:
- 4.0.0
- See Also:
for details on page values
-
pages
@Contract("_ -> this") @NotNull @NotNull Book.Builder pages(@NotNull @NotNull Collection<Component> pages)Add pages to the book.- Parameters:
pages
- pages to add- Returns:
- this
- Since:
- 4.0.0
- See Also:
for details on page values
-
build
Builds.- Specified by:
build
in interfaceBuildable.Builder<Book>
- Returns:
- a new book
-