org.anvilpowered.anvil.api.util

Interface TextService.PaginationBuilder<TString,TCommandSource>

Enclosing interface:

TextService<TString,TCommandSource>

public static interface TextService.PaginationBuilder<TString,TCommandSource>

Method Summary

Modifier and Type	Method and Description
TextService.Pagination<TString,TCommandSource>	build() Creates a TextService.Pagination from this builder
TextService.PaginationBuilder<TString,TCommandSource>	contents(java.lang.Iterable<TString> contents) Sets the contents of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	contents(TString... contents) Sets the contents of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	footer(@Nullable TextService.Builder<TString,TCommandSource> footer) Sets the footer of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	footer(TString footer) Sets the footer of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	header(@Nullable TextService.Builder<TString,TCommandSource> header) Sets the header of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	header(TString header) Sets the header of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	linesPerPage(int linesPerPge) Sets the maximum number of lines for this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	padding(TextService.Builder<TString,TCommandSource> padding) Sets the padding of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	padding(TString padding) Sets the padding of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	title(@Nullable TextService.Builder<TString,TCommandSource> title) Sets the title of this TextService.PaginationBuilder.
TextService.PaginationBuilder<TString,TCommandSource>	title(TString title) Sets the title of this TextService.PaginationBuilder.

Method Detail

contents

TextService.PaginationBuilder<TString,TCommandSource> contents(TString... contents)

Sets the contents of this TextService.PaginationBuilder.

Parameters:

contents - The contents to set

Returns:

this

contents

TextService.PaginationBuilder<TString,TCommandSource> contents(java.lang.Iterable<TString> contents)

Sets the contents of this TextService.PaginationBuilder.

Parameters:

contents - The contents to set

Returns:

this

title

TextService.PaginationBuilder<TString,TCommandSource> title(@Nullable
                                                            TString title)

Sets the title of this TextService.PaginationBuilder.

Parameters:

title - The title to set, should be exactly one line

Returns:

this

title

TextService.PaginationBuilder<TString,TCommandSource> title(@Nullable
                                                            @Nullable TextService.Builder<TString,TCommandSource> title)

Sets the title of this TextService.PaginationBuilder.

Parameters:

title - The title to set, should be exactly one line

Returns:

this

header

TextService.PaginationBuilder<TString,TCommandSource> header(@Nullable
                                                             TString header)

Sets the header of this TextService.PaginationBuilder.

If the header is not specified, or passed in as null, it will be omitted when displaying this pagination.

Parameters:

header - The header to set

Returns:

this

header

TextService.PaginationBuilder<TString,TCommandSource> header(@Nullable
                                                             @Nullable TextService.Builder<TString,TCommandSource> header)

Sets the header of this TextService.PaginationBuilder.

If the header is not specified, or passed in as null, it will be omitted when displaying this pagination.

Parameters:

header - The header to set

Returns:

this

footer

TextService.PaginationBuilder<TString,TCommandSource> footer(@Nullable
                                                             TString footer)

Sets the footer of this TextService.PaginationBuilder.

If the footer is not specified, or passed in as null, it will be omitted when displaying this pagination.

Parameters:

footer - The footer to set

Returns:

this

footer

TextService.PaginationBuilder<TString,TCommandSource> footer(@Nullable
                                                             @Nullable TextService.Builder<TString,TCommandSource> footer)

Sets the footer of this TextService.PaginationBuilder.

If the footer is not specified, or passed in as null, it will be omitted when displaying this pagination.

Parameters:

footer - The footer to set

Returns:

this

padding

TextService.PaginationBuilder<TString,TCommandSource> padding(TString padding)

Sets the padding of this TextService.PaginationBuilder.

Parameters:

padding - The padding to set

Returns:

this

padding

TextService.PaginationBuilder<TString,TCommandSource> padding(TextService.Builder<TString,TCommandSource> padding)

Sets the padding of this TextService.PaginationBuilder.

Parameters:

padding - The padding to set

Returns:

this

linesPerPage

TextService.PaginationBuilder<TString,TCommandSource> linesPerPage(int linesPerPge)

Sets the maximum number of lines for this TextService.PaginationBuilder.

Parameters:

linesPerPge - The lines per page to set

Returns:

this

Throws:

java.lang.IllegalArgumentException - If linesPerPage < 1

build

TextService.Pagination<TString,TCommandSource> build()

Creates a TextService.Pagination from this builder

Returns:

The built TextService.Pagination