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 aBook
.- Since:
- 4.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NonNull Book.Builder
addPage(@NonNull Component page)
Add a page to the book.@NonNull Book.Builder
author(@NonNull Component author)
Set the author.@NonNull Book
build()
Builds.@NonNull Book.Builder
pages(@NonNull Collection<Component> pages)
Add pages to the book.@NonNull Book.Builder
pages(@NonNull Component @NonNull ... pages)
Add pages to the book.@NonNull Book.Builder
title(@NonNull Component title)
Set the title.
-
-
-
Method Detail
-
title
@Contract("_ -> this") @NonNull Book.Builder title(@NonNull Component title)
Set the title.- Parameters:
title
- the title- Returns:
- this
- Since:
- 4.0.0
-
author
@Contract("_ -> this") @NonNull Book.Builder author(@NonNull Component author)
Set the author.- Parameters:
author
- the author- Returns:
- this
- Since:
- 4.0.0
-
addPage
@Contract("_ -> this") @NonNull Book.Builder addPage(@NonNull Component page)
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") @NonNull Book.Builder pages(@NonNull Component @NonNull ... 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") @NonNull Book.Builder pages(@NonNull 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
@NonNull Book build()
Builds.- Specified by:
build
in interfaceBuildable.Builder<Book>
- Returns:
- a new book
-
-