xyz.upperlevel.spigot.book

Class BookUtil.PageBuilder

java.lang.Object

xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Enclosing class:

BookUtil

public static class BookUtil.PageBuilder
extends Object

Helps the user creating a book's page

Constructor Summary

Constructors

Constructor and Description
PageBuilder()

Method Summary

Modifier and Type	Method and Description
BookUtil.PageBuilder	add(net.md_5.bungee.api.chat.BaseComponent... components) Adds one or more components to the page
BookUtil.PageBuilder	add(net.md_5.bungee.api.chat.BaseComponent component) Adds a component to the page
BookUtil.PageBuilder	add(Collection<net.md_5.bungee.api.chat.BaseComponent> components) Adds one or more components to the page
BookUtil.PageBuilder	add(String text) Adds a simple black-colored text to the page
net.md_5.bungee.api.chat.BaseComponent[]	build() Builds the page
BookUtil.PageBuilder	newLine() Adds a newline to the page (equivalent of adding \n to the previous component)
static BookUtil.PageBuilder	of(net.md_5.bungee.api.chat.BaseComponent... text) Creates a new PageBuilder instance wih the parameter as the initial components
static BookUtil.PageBuilder	of(net.md_5.bungee.api.chat.BaseComponent text) Creates a new PageBuilder instance wih the parameter as the initial component
static BookUtil.PageBuilder	of(String text) Creates a new PageBuilder instance wih the parameter as the initial text

Methods inherited from class java.lang.Object

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

Constructor Detail

PageBuilder

public PageBuilder()

Method Detail

add

public BookUtil.PageBuilder add(String text)

Adds a simple black-colored text to the page

Parameters:

text - the text to add

Returns:

the PageBuilder's calling instance

add

public BookUtil.PageBuilder add(net.md_5.bungee.api.chat.BaseComponent component)

Adds a component to the page

Parameters:

component - the component to add

Returns:

the PageBuilder's calling instance

add

public BookUtil.PageBuilder add(net.md_5.bungee.api.chat.BaseComponent... components)

Adds one or more components to the page

Parameters:

components - the components to add

Returns:

the PageBuilder's calling instance

add

public BookUtil.PageBuilder add(Collection<net.md_5.bungee.api.chat.BaseComponent> components)

Adds one or more components to the page

Parameters:

components - the components to add

Returns:

the PageBuilder's calling instance

newLine

public BookUtil.PageBuilder newLine()

Adds a newline to the page (equivalent of adding \n to the previous component)

Returns:

the PageBuilder's calling instance

build

public net.md_5.bungee.api.chat.BaseComponent[] build()

Builds the page

Returns:

an array of BaseComponents representing the page

of

public static BookUtil.PageBuilder of(String text)

Creates a new PageBuilder instance wih the parameter as the initial text

Parameters:

text - the initial text of the page

Returns:

a new PageBuilder with the parameter as the initial text

of

public static BookUtil.PageBuilder of(net.md_5.bungee.api.chat.BaseComponent text)

Creates a new PageBuilder instance wih the parameter as the initial component

Parameters:

text - the initial component of the page

Returns:

a new PageBuilder with the parameter as the initial component

of

public static BookUtil.PageBuilder of(net.md_5.bungee.api.chat.BaseComponent... text)

Creates a new PageBuilder instance wih the parameter as the initial components

Parameters:

text - the initial components of the page

Returns:

a new PageBuilder with the parameter as the initial components