me.vaperion.blade.util.command

Class PaginatedOutput<Value,Text>

java.lang.Object

me.vaperion.blade.util.command.PaginatedOutput<Value,Text>

public abstract class PaginatedOutput<Value,Text>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaginatedOutput.Error

Constructor Summary

Constructors

Constructor and Description
PaginatedOutput(int resultsPerPage)

Method Summary

Modifier and Type	Method and Description
abstract Text	error(@NotNull PaginatedOutput.Error error, java.lang.Object... args) Formats an error message based on the provided error type and arguments.
abstract Text	footer(int page, int totalPages) Generates the footer text for a specific page.
@NotNull java.util.List<Text>	generatePage(@NotNull java.util.List<Value> results, int page)
abstract Text	header(int page, int totalPages) Generates the header text for a specific page.
abstract Text	line(Value result, int index) Formats a single line of output for a given result and its index.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginatedOutput

public PaginatedOutput(int resultsPerPage)

Method Detail

error

@NotNull
public abstract Text error(@NotNull
                                    @NotNull PaginatedOutput.Error error,
                                    java.lang.Object... args)

Formats an error message based on the provided error type and arguments.

Parameters:

error - the type of error

args - additional arguments for formatting the error message

Returns:

the formatted error message

header

@Nullable
public abstract Text header(int page,
                                      int totalPages)

Generates the header text for a specific page.

Parameters:

page - the current page number

totalPages - the total number of pages

Returns:

the header text for the specified page

footer

@Nullable
public abstract Text footer(int page,
                                      int totalPages)

Generates the footer text for a specific page.

Parameters:

page - the current page number

totalPages - the total number of pages

Returns:

the footer text for the specified page

line

@Nullable
public abstract Text line(Value result,
                                    int index)

Formats a single line of output for a given result and its index.

Parameters:

result - the result to format

index - the index of the result

Returns:

the formatted line of output

generatePage

@NotNull
public final @NotNull java.util.List<Text> generatePage(@NotNull
                                                                 @NotNull java.util.List<Value> results,
                                                                 int page)