org.spongepowered.api.text

Class BookView.Builder

java.lang.Object

org.spongepowered.api.text.BookView.Builder

All Implemented Interfaces:

ResettableBuilder<BookView,BookView.Builder>

Enclosing class:

BookView

public static final class BookView.Builder
extends Object
implements ResettableBuilder<BookView,BookView.Builder>

Builder class to assist in creation of a new BookView.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BookView.Builder	addPage(Text page) Adds a page to the end of the BookView.
BookView.Builder	addPages(Collection<Text> pages) Adds multiple pages to the end of the BookView.
BookView.Builder	addPages(Text... pages) Adds multiple pages to the end of the BookView.
BookView.Builder	author(Text author) Sets the author of the BookView.
BookView	build() Creates a new BookView from the current state of this builder.
BookView.Builder	clearPages() Removes all pages from the BookView.
BookView.Builder	from(BookView value) Resets this builder to the values of the given built object.
BookView.Builder	insertPage(int i, Text page) Inserts a page at the specified index of the BookView.
BookView.Builder	insertPages(int i, Collection<Text> pages) Inserts multiple pages at the specified index of the BookView.
BookView.Builder	insertPages(int i, Text... pages) Inserts multiple pages at the specified index of the BookView.
BookView.Builder	removePage(int i) Removes the page at the specified index of the BookView.
BookView.Builder	removePage(Text page) Removes a page from the BookView.
BookView.Builder	removePages(Collection<Text> pages) Removes multiple pages from the BookView.
BookView.Builder	removePages(Text... pages) Removes multiple pages from the BookView.
BookView.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
BookView.Builder	title(Text title) Sets the title of the BookView.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

title

public BookView.Builder title(Text title)

Sets the title of the BookView.

Parameters:

title - Title of BookView

Returns:

This builder

author

public BookView.Builder author(Text author)

Sets the author of the BookView.

Parameters:

author - Author of BookView

Returns:

This builder

addPage

public BookView.Builder addPage(Text page)

Adds a page to the end of the BookView.

Parameters:

page - Page to add

Returns:

This builder

addPages

public BookView.Builder addPages(Collection<Text> pages)

Adds multiple pages to the end of the BookView.

Parameters:

pages - Pages to add

Returns:

This builder

addPages

public BookView.Builder addPages(Text... pages)

Adds multiple pages to the end of the BookView.

Parameters:

pages - Pages to add

Returns:

This builder

insertPage

public BookView.Builder insertPage(int i,
                                   Text page)

Inserts a page at the specified index of the BookView.

Parameters:

i - Index to insert page at

page - Page to insert

Returns:

This builder

insertPages

public BookView.Builder insertPages(int i,
                                    Collection<Text> pages)

Inserts multiple pages at the specified index of the BookView.

Parameters:

i - Index to insert pages at

pages - Pages to insert

Returns:

This builder

insertPages

public BookView.Builder insertPages(int i,
                                    Text... pages)

Inserts multiple pages at the specified index of the BookView.

Parameters:

i - Index to insert pages at

pages - Pages to insert

Returns:

This builder

removePage

public BookView.Builder removePage(Text page)

Removes a page from the BookView.

Parameters:

page - Page to remove

Returns:

This builder

removePage

public BookView.Builder removePage(int i)

Removes the page at the specified index of the BookView.

Parameters:

i - Index of page to remove

Returns:

This builder

removePages

public BookView.Builder removePages(Collection<Text> pages)

Removes multiple pages from the BookView.

Parameters:

pages - Pages to remove

Returns:

This builder

removePages

public BookView.Builder removePages(Text... pages)

Removes multiple pages from the BookView.

Parameters:

pages - Pages to remove

Returns:

This builder

clearPages

public BookView.Builder clearPages()

Removes all pages from the BookView.

Returns:

This builder

build

public BookView build()

Creates a new BookView from the current state of this builder.

Returns:

New BookView

from

public BookView.Builder from(BookView value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface ResettableBuilder<BookView,BookView.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public BookView.Builder reset()

Description copied from interface: ResettableBuilder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface ResettableBuilder<BookView,BookView.Builder>

Returns:

This builder, for chaining