Package tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination

Class PaginationSourceSpec<T>

java.lang.Object

tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec<T>

Type Parameters:

T - the element type served by the source

@Internal
public final class PaginationSourceSpec<T>
extends Object

Immutable source declaration of one pagination token: which of the four source kinds the view declared, and how to construct the PageSource for one context. PaginationSourceSpec.Kind.EAGER_STATIC carries the ONE EagerPageSource shared by every context — safe because that source is immutable; every other kind constructs a fresh source per context, preserving per-context isolation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PaginationSourceSpec.Kind	The four ways a view can declare where page elements come from.

Method Summary

Modifier and Type	Method	Description
static <T> @NotNull PaginationSourceSpec<T>	async(@NotNull AsyncPageSupplier<T> supplier)	Declares an async source: a fresh AsyncPageSource is constructed per context from the supplier and the owning spec's async options.
@NotNull PageSource<T>	createSource(@NotNull ViewContext context, @NotNull PaginationSpec<T> spec, @NotNull PlatformScheduler scheduler)	Creates (or returns) the PageSource for one context.
static <T> @NotNull PaginationSourceSpec<T>	custom(@NotNull Function<ViewContext,PageSource<T>> factory)	Declares a custom source: the factory runs once per context and its result is used as-is.
static <T> @NotNull PaginationSourceSpec<T>	eager(@NotNull List<T> source)	Declares a static eager source.
boolean	isAsync()	Returns whether this is an async declaration — the gate for the async-only builder options.
@NotNull PaginationSourceSpec.Kind	kind()	Returns the source kind.
static <T> @NotNull PaginationSourceSpec<T>	lazy(@NotNull Function<ViewContext,List<T>> source)	Declares a lazy eager source: source runs once per context at initialization (and again on Pagination.refresh), each result wrapped in a fresh EagerPageSource.
@Nullable Function<ViewContext,List<T>>	lazyFunction()	Returns the lazy list function, used by the Pagination.refresh path to re-evaluate the source.

Methods inherited from class java.lang.Object

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

Method Details

eager

@NotNull
public static <T> @NotNull PaginationSourceSpec<T> eager(@NotNull
 @NotNull List<T> source)

Declares a static eager source. The ONE shared EagerPageSource every context will use is built immediately; the defensive copy of source is taken by the EagerPageSource constructor itself, so later mutation of the caller's list never leaks into pages.

Type Parameters:

T - the element type

Parameters:

source - the backing elements

Returns:

the source spec

Throws:

NullPointerException - if source is null

lazy

@NotNull
public static <T> @NotNull PaginationSourceSpec<T> lazy(@NotNull
 @NotNull Function<ViewContext,List<T>> source)

Declares a lazy eager source: source runs once per context at initialization (and again on Pagination.refresh), each result wrapped in a fresh EagerPageSource.

Type Parameters:

T - the element type

Parameters:

source - produces the backing elements for one context

Returns:

the source spec

Throws:

NullPointerException - if source is null

async

@NotNull
public static <T> @NotNull PaginationSourceSpec<T> async(@NotNull
 @NotNull AsyncPageSupplier<T> supplier)

Declares an async source: a fresh AsyncPageSource is constructed per context from the supplier and the owning spec's async options.

Type Parameters:

T - the element type

Parameters:

supplier - loads pages on demand

Returns:

the source spec

Throws:

NullPointerException - if supplier is null

custom

@NotNull
public static <T> @NotNull PaginationSourceSpec<T> custom(@NotNull
 @NotNull Function<ViewContext,PageSource<T>> factory)

Declares a custom source: the factory runs once per context and its result is used as-is.

Type Parameters:

T - the element type

Parameters:

factory - produces the page source for one context

Returns:

the source spec

Throws:

NullPointerException - if factory is null

kind

@NotNull
public @NotNull PaginationSourceSpec.Kind kind()

Returns the source kind.

Returns:

the kind

isAsync

public boolean isAsync()

Returns whether this is an async declaration — the gate for the async-only builder options.

Returns:

true when kind() is PaginationSourceSpec.Kind.ASYNC

lazyFunction

@Nullable
public @Nullable Function<ViewContext,List<T>> lazyFunction()

Returns the lazy list function, used by the Pagination.refresh path to re-evaluate the source.

Returns:

the function; non-null only for PaginationSourceSpec.Kind.EAGER_LAZY

createSource

@NotNull
public @NotNull PageSource<T> createSource(@NotNull
 @NotNull ViewContext context,
 @NotNull
 @NotNull PaginationSpec<T> spec,
 @NotNull
 @NotNull PlatformScheduler scheduler)

Creates (or returns) the PageSource for one context.

• PaginationSourceSpec.Kind.EAGER_STATIC: returns the single shared EagerPageSource built by eager(List).
• PaginationSourceSpec.Kind.EAGER_LAZY: invokes the source function with context and wraps the result in a fresh EagerPageSource (whose constructor takes the defensive copy).
• PaginationSourceSpec.Kind.ASYNC: constructs a fresh AsyncPageSource from the supplier and the spec's async options, dispatching settles through a BukkitSettleDispatcher backed by the given scheduler.
• PaginationSourceSpec.Kind.CUSTOM: invokes the factory with context and returns its result as-is.

Parameters:

context - the context the source will serve

spec - the owning spec, read for the async options

scheduler - the platform scheduler used to route async settles to the viewer's region thread; passed through to the BukkitSettleDispatcher for PaginationSourceSpec.Kind.ASYNC sources

Returns:

the page source for this context

Throws:

NullPointerException - if the lazy function returns null ("lazy pagination source function returned null"), or the custom factory returns null ("paginateSource factory returned null"), or an argument is null