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

Class PaginationSpec<T>

java.lang.Object

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

Type Parameters:

T - the element type served by the source

@Internal
public final class PaginationSpec<T>
extends Object

Immutable pagination declaration built by PaginationBuilderImpl.build(): geometry, paint target, renderer and frame items, the source declaration, and the async plumbing consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler). All combination validation happens in the builder before a spec is constructed; the spec only carries the validated values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PaginationSpec.Geometry	How elements are distributed across pages.
static enum	PaginationSpec.Target	Where the page items are painted.

Method Summary

Modifier and Type	Method	Description
int	cacheMaxPages()	Returns the async cache LRU bound, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).
@Nullable Duration	cacheTtl()	Returns the async cache TTL, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).
@Nullable Function<ViewContext,org.bukkit.inventory.ItemStack>	emptyStateItem()	Returns the empty-state item painted at emptyStateSlots() when the current page settled with no elements.
int[]	emptyStateSlots()	Returns the absolute slots the empty-state item paints into.
@Nullable PaginationErrorCallback	errorCallback()	Returns the async error callback, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).
@Nullable Layout	explicitLayout()	Returns the explicit fill order.
@Nullable Function<ViewContext,org.bukkit.inventory.ItemStack>	fallbackItem()	Returns the frame item painted into page slots not covered by an element.
@NotNull PaginationSpec.Geometry	geometry()	Returns the page geometry.
char	layoutChar()	Returns the target layout character, meaningful only when target() is PaginationSpec.Target.LAYOUT_CHAR.
@Nullable Function<ViewContext,org.bukkit.inventory.ItemStack>	loadingItem()	Returns the frame item painted into every page slot while an async load is in flight.
int[]	loadingSlots()	Returns the absolute slots the loading item paints into.
@NotNull List<Layout>	patterns()	Returns the per-page patterns.
@NotNull PaginationItemRenderer<T>	renderer()	Returns the per-element renderer.
@Nullable Duration	requestTimeout()	Returns the async per-request timeout, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).
@NotNull PaginationSourceSpec<T>	source()	Returns the source declaration.
@NotNull PaginationSpec.Target	target()	Returns the paint target.

Methods inherited from class java.lang.Object

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

Method Details

geometry

@NotNull
public @NotNull PaginationSpec.Geometry geometry()

Returns the page geometry.

Returns:

the geometry

target

@NotNull
public @NotNull PaginationSpec.Target target()

Returns the paint target.

Returns:

the target

layoutChar

public char layoutChar()

Returns the target layout character, meaningful only when target() is PaginationSpec.Target.LAYOUT_CHAR.

Returns:

the layout character, 'O' by default

explicitLayout

@Nullable
public @Nullable Layout explicitLayout()

Returns the explicit fill order.

Returns:

the explicit layout, or null unless target() is PaginationSpec.Target.EXPLICIT_LAYOUT

patterns

@NotNull
public @NotNull List<Layout> patterns()

Returns the per-page patterns.

Returns:

an unmodifiable list; empty unless target() is PaginationSpec.Target.PATTERNS

renderer

@NotNull
public @NotNull PaginationItemRenderer<T> renderer()

Returns the per-element renderer.

Returns:

the renderer

fallbackItem

@Nullable
public @Nullable Function<ViewContext,org.bukkit.inventory.ItemStack> fallbackItem()

Returns the frame item painted into page slots not covered by an element.

Returns:

the fallback item factory, or null when uncovered slots are cleared

loadingItem

@Nullable
public @Nullable Function<ViewContext,org.bukkit.inventory.ItemStack> loadingItem()

Returns the frame item painted into every page slot while an async load is in flight.

Returns:

the loading item factory, or null

source

@NotNull
public @NotNull PaginationSourceSpec<T> source()

Returns the source declaration.

Returns:

the source spec

errorCallback

@Nullable
public @Nullable PaginationErrorCallback errorCallback()

Returns the async error callback, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).

Returns:

the callback, or null

requestTimeout

@Nullable
public @Nullable Duration requestTimeout()

Returns the async per-request timeout, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).

Returns:

the timeout, or null when disabled

cacheTtl

@Nullable
public @Nullable Duration cacheTtl()

Returns the async cache TTL, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).

Returns:

the TTL, or null when caching is disabled

cacheMaxPages

public int cacheMaxPages()

Returns the async cache LRU bound, consumed by PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler).

Returns:

the bound; 128 unless overridden (the 2.x DEFAULT_CACHE_MAX_PAGES)

emptyStateItem

@Nullable
public @Nullable Function<ViewContext,org.bukkit.inventory.ItemStack> emptyStateItem()

Returns the empty-state item painted at emptyStateSlots() when the current page settled with no elements.

Returns:

the empty-state item factory, or null when no empty-state is declared

emptyStateSlots

public int[] emptyStateSlots()

Returns the absolute slots the empty-state item paints into.

Returns:

a defensive copy; empty when no empty-state is declared

loadingSlots

public int[] loadingSlots()

Returns the absolute slots the loading item paints into.

Returns:

a defensive copy; empty when the loading item fills the whole layout