Package dev.sympho.bot_utils

Class PaginationManager

java.lang.Object

dev.sympho.bot_utils.PaginationManager

public class PaginationManager
extends Object

Manager for displaying paginated data.

Note that, in order for an instance of this class to begin operating, it must be registered with a ButtonManager using the handler given by pageUpdateHandler().

Since:

1.0

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PaginationManager.PageData	The data of a page to be displayed.
static interface	PaginationManager.PageGenerator	A function that generates the contents of a page.
final class	PaginationManager.Paginator	Entity responsible for generating content pages of a certain type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON_ID_DISPLAY	The ID for the counter display button.
static final String	BUTTON_ID_UPDATE	The base ID for an update button.

Constructor Summary

Constructors

Constructor	Description
PaginationManager()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ButtonManager.Handler	pageUpdateHandler()	Configures the handler for page update buttons.
PaginationManager.Paginator	register(String id, @Nullable Group requiredGroup, PaginationManager.PageGenerator generator)	Registers a paginator.
PaginationManager.Paginator	register(String id, PaginationManager.PageGenerator generator)	Registers a paginator with no access restrictions.

Methods inherited from class java.lang.Object

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

Field Details

BUTTON_ID_UPDATE

public static final String BUTTON_ID_UPDATE

The base ID for an update button.

See Also:

• Constant Field Values

BUTTON_ID_DISPLAY

public static final String BUTTON_ID_DISPLAY

The ID for the counter display button.

See Also:

• Constant Field Values

Constructor Details

PaginationManager

public PaginationManager()

Creates a new instance.

Method Details

register

public PaginationManager.Paginator register(String id,
 @Nullable Group requiredGroup,
 PaginationManager.PageGenerator generator)
                                     throws IllegalArgumentException

Registers a paginator.

Parameters:

id - The page type ID.

requiredGroup - The group that a user must belong to to interact with the page controls. If null, defaults to everyone.

generator - The generator function for page data.

Returns:

The paginator.

Throws:

IllegalArgumentException - if there is already a registered paginator for the given type ID.

register

public PaginationManager.Paginator register(String id,
 PaginationManager.PageGenerator generator)

Registers a paginator with no access restrictions.

Equivalent to register(id, null, generator).

Parameters:

id - The page type ID.

generator - The generator function for page data.

Returns:

The paginator.

Throws:

IllegalArgumentException - if there is already a registered paginator for the given type ID.

pageUpdateHandler

public ButtonManager.Handler pageUpdateHandler()

Configures the handler for page update buttons. Must be registered with a button manager for this pagination manager to work.

Returns:

The handler.