Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractViewContext - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Base implementation shared by every per-phase context: resolves all
ViewContextaccessors from the bound session and routes the mutating operations through the engine. - AbstractViewContext(ViewSession, ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
-
Binds the context to one session and the engine.
- ACTIVE - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession.Status
-
The container is shown; clicks and updates are routed.
- add(ComponentInstance) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentTable
-
Registers a component; validated before any slot is bound so a failed add leaves the table unchanged.
- advance(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- advance(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Navigates one page forward, clamped exactly like
Pagination.switchTo(tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext, int). - all() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentTable
- all() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.ViewRegistry
-
Returns every registration in registration order.
- all() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.SessionRegistry
-
Returns every registered session.
- API - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
ViewService.closeorViewContext.close()was called. - apply(Player, String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.placeholder.NoopPlaceholderApplier
- apply(Player, String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.placeholder.PapiPlaceholderApplier
- apply(Player, String) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.placeholder.PlaceholderApplier
-
Applies placeholders to a single text fragment.
- applyAll(Player, List<String>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.placeholder.PlaceholderApplier
-
Applies placeholders to every entry of a list, preserving order and tolerating
nullentries. - applyPlaceholders() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns whether placeholders are applied at paint time (default
true). - applyPlaceholders(boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Sets whether placeholders are applied at paint time (default
true). - applyText(Player, String, boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.render.SlotPainter
-
Applies placeholders to a single text fragment (e.g.
- arguments() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the arguments this session was opened with; empty when none were passed.
- arguments() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- arguments() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the arguments this open was requested with.
- assertMainThread(String) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.util.ThreadUtils
-
Throws when not on the main server thread; when no server is present (pure unit tests), the check is skipped.
- assertOwnsRegion(PlatformScheduler, Entity, String) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.util.ThreadUtils
-
Throws when the current thread does not own the entity's region.
- async(AsyncPageSupplier<T>) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Declares an async source: a fresh
AsyncPageSourceis constructed per context from the supplier and the owning spec's async options. - ASYNC - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec.Kind
-
View.paginateAsync(AsyncPageSupplier): a fresh async source per context. - AsyncPageSource<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Asynchronous
PageSourcebacked by anAsyncPageSupplier. - AsyncPageSource(AsyncPageSupplier<T>, PaginationErrorCallback, Duration, Duration, int, SettleDispatcher) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
-
Creates an async page source.
- AsyncPageSupplier<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Loads one page of elements asynchronously, typically from a database.
B
- back(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- back(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Navigates one page backward, clamped exactly like
Pagination.switchTo(tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext, int). - bind(PaginationHost) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- bind(PaginationHost) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Binds the engine against a freshly opened host: sets the host, derives the navigation state for the current (possibly pre-recorded) page and dispatches the initial load without requesting a render — the open's initial paint covers it.
- boundLayoutChars() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
-
Returns the layout characters successfully bound through
RenderContextImpl.layoutSlot(char)during this render, in declaration order; the first-render phase subtracts them when warning about layout characters bound to neither a component nor pagination. - build() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Validates and freezes the configuration.
- build() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- build() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Validates the declaration, constructs the token and registers it with the owning view.
- build() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments.Builder
-
Builds an immutable snapshot of the accumulated entries.
- builder() - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Creates a new builder for arguments with any number of entries.
- bukkitClose(ViewSession, InventoryCloseEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Handles a Bukkit close event for a session, guarded by container identity: a close event for a previous container (fired synchronously while opening a new view) must not tear down the session of the view that is being opened.
- BukkitSettleDispatcher - Class in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Default
SettleDispatcher: settles route to the viewer's region thread (Folia) or the main thread (legacy Spigot/Paper) via the injectedPlatformScheduler. - BukkitSettleDispatcher(PlatformScheduler) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.BukkitSettleDispatcher
-
Creates the dispatcher.
C
- cacheMaxPages() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the async cache LRU bound, consumed by
PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler). - cacheMaxPages(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- cacheMaxPages(int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Bounds the page cache (least-recently-used eviction).
- cacheTtl() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the async cache TTL, consumed by
PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler). - cacheTtl(Duration) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- cacheTtl(Duration) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Enables page caching: revisiting a page within the TTL renders from cache without calling the supplier;
Pagination.refresh(ViewContext)invalidates the cache. - canAdvance(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- canAdvance(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns whether a next page exists, i.e.
- canBack(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- canBack(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns whether a previous page exists, i.e.
- cancelOnClick() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns whether clicks are cancelled by default (default
true). - cancelOnClick() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
- cancelOnClick(boolean) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Overrides the config-level click cancellation for this component's slots; handlers may still overturn the decision via
SlotClickContext.setCancelled(boolean). - cancelOnClick(boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Sets whether clicks are cancelled by default (default
true). - cancelOnClick(boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- cancelOnDrag() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns whether drags are cancelled by default (default
true). - cancelOnDrag(boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Sets whether drags are cancelled by default (default
true). - cancelOpen() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.OpenContext
-
Aborts this open with zero side effects; the player's current view is untouched.
- cancelOpen() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- changePage(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- changePage(int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Navigates directly to the given 1-indexed page.
- click(ViewSession, InventoryClickEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Routes a Bukkit click event into the session per the click policy.
- clickDispatch(boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Marks the engine as inside or outside click dispatch; toggled by
ViewEngine.click(tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession, org.bukkit.event.inventory.InventoryClickEvent)around routing. - ClickRoutingPhase - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
-
Click policy and routing (spec §6): pre-cancel from config and per-component override, handler dispatch with last-writer-wins cancellation, the safety-floor actions force-cancelled after handlers, and end-of-tick post-actions.
- ClickRoutingPhase(ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.ClickRoutingPhase
-
Creates the phase.
- clickType() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Returns the Bukkit click type of this click.
- clickType() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- close() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Closes this session.
- close() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- close() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
- close(Player) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewService
-
Closes the player's open view; no-op when none is open.
- close(ViewSession, CloseReason) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.ClosePhase
-
Closes a session with the given reason; closing an already closed session is a no-op.
- close(ViewSession, CloseReason) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Closes a session with the given reason; idempotent on already closed sessions.
- CloseContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Context for
View.onClose: the session is tearing down. - CloseContextImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Context for
View.onClose: the session is tearing down. - CloseContextImpl(ViewSession, ViewEngine, CloseReason) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
-
Creates the context for one teardown.
- CLOSED - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession.Status
-
The session tore down; terminal.
- closeOnClick() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Closes the view after a click on this component; deferred to the end of the tick.
- closeOnClick() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
- closeOnClick() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- ClosePhase - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
-
Session teardown: idempotent on closed sessions, cancels the update task, marks the session closed, runs
onClose(a throw is logged, teardown always completes), unregisters the session, drops pending deferred operations and closes a container the client still shows after an engine-initiated close. - ClosePhase(ViewEngine, SessionRegistry) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.ClosePhase
-
Creates the phase.
- CloseReason - Enum Class in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Why a session closed; exposed through
CloseContext.reason(). - commitNavigation(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- commitNavigation(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- commitNavigation(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- componentAt(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentTable
- componentAt(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the page-element component currently occupying a slot.
- componentAt(ViewSession, int) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBindings
-
Looks up the pagination element component currently occupying a slot.
- ComponentInstance - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.component
-
Immutable materialized item component: fixed slots, item source, visibility predicate, click handlers, post-actions and watched token ids.
- components() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns this session's component table; one stable instance for the session's lifetime.
- ComponentTable - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.component
-
Per-session component registry: maps slots to their owning component and resolves the components watching a set of dirty token ids.
- ComponentTable() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentTable
- config() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the effective configuration of this session, with per-open overrides recorded in
onOpenalready applied. - config() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- config() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.RegisteredView
-
Returns the frozen registration-time config; per-open overrides are merged onto a copy by the open phase, never onto this instance.
- contextActive() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- contextActive() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateBackedContext
-
Returns whether this context may still access state;
falseonce closed. - contextOf(Player) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewService
-
Returns a live context for the player's open view, if any.
- ContextStateAccess - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Resolver from a public
ViewContextto its state backing; token impls never cast to concrete context classes, only toStateBackedContext. - create(int, T) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PageItemFactory
-
Creates the rendered slot content for one page element.
- createSource(ViewContext, PaginationSpec<T>, PlatformScheduler) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Creates (or returns) the
PageSourcefor one context. - currentPage - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- currentPage(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- currentPage(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns the current page, 1-indexed.
- custom(Function<ViewContext, PageSource<T>>) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Declares a custom source: the factory runs once per context and its result is used as-is.
- CUSTOM - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec.Kind
-
View.paginateSource(Function): the escape hatch, the factory runs once per context.
D
- defer(ViewSession, Runnable) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Defers an operation to the end of the current tick.
- deferredOps() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the operations deferred to the end of the current tick; the engine appends during click dispatch and drains in FIFO order at tick end, removing each op from the queue before it runs.
- DISCONNECT - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
The player disconnected.
- discoverFromPackage(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.discovery.ViewDiscoveryService
-
Discovers the registrable view classes under the given base package.
- DiscoveryIndex_8cdfe239bc863e8f - Class in tech.guilhermekaua.spigotboot.generated
- DiscoveryIndex_8cdfe239bc863e8f() - Constructor for class tech.guilhermekaua.spigotboot.generated.DiscoveryIndex_8cdfe239bc863e8f
- dispatch(PageRequest, Runnable) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.BukkitSettleDispatcher
- dispatch(PageRequest, Runnable) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.SettleDispatcher
-
Runs the settle task on the appropriate thread for the given request.
- displayIf(Predicate<ViewContext>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Shows this component only while the condition holds; a hidden component's slots are cleared and it receives no clicks.
- displayIf(Predicate<ViewContext>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- drag(ViewSession, InventoryDragEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Applies the drag policy of a session: when
cancelOnDragis enabled, any drag touching the top container is cancelled (mirrors the 2.x listener behavior). - drainDirty() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateStore
-
Returns the dirty token ids and clears the dirty set.
E
- eager(List<T>) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Declares a static eager source.
- EAGER_LAZY - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec.Kind
-
View.paginate(Function): the function runs once per context at init (and again on refresh), each result wrapped in a fresh eager source. - EAGER_STATIC - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec.Kind
-
View.paginate(List): one immutable in-memory source shared by every context. - EagerPageSource<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
In-memory
PageSource: serves slices of a fixed list and settles every request synchronously on the calling thread. - EagerPageSource(List<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
-
Creates an eager source over a defensive copy of the given list.
- effectiveConfig() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the effective configuration of this session: the registered config until the open phase applies per-open overrides.
- effectiveConfig(ViewConfig) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Sets the effective configuration after per-open overrides were merged.
- elementBuilder() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem
-
Returns the element declaration carried by this output.
- elements() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- elements() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- elements() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
- elementWatchersOf(Set<Integer>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the current page-element components watching any of the given token ids.
- empty() - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- empty() - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Returns the shared empty arguments instance.
- emptyOrFallback() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- emptyStateItem() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the empty-state item painted at
PaginationSpec.emptyStateSlots()when the current page settled with no elements. - emptyStateItem(Function<ViewContext, ItemStack>, int...) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- emptyStateItem(Function<ViewContext, ItemStack>, int...) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets an item painted into the given slots when the current page settled with no elements, leaving every other layout slot empty.
- emptyStateSlots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the absolute slots the empty-state item paints into.
- engine() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
-
Returns the engine this context routes operations through.
- entries() - Method in class tech.guilhermekaua.spigotboot.generated.DiscoveryIndex_8cdfe239bc863e8f
- errorCallback() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the async error callback, consumed by
PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler). - EXPLICIT - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateTrigger
-
Explicit
ViewContext.update()or service-driven update. - EXPLICIT_LAYOUT - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Target
-
An explicit
Layoutfill order. - explicitLayout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the explicit fill order.
F
- failure() - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem
-
Returns the failure sentinel: the slot keeps its previous content (item and click handlers); on a first paint with no previous content the fallback item is painted instead.
- fallbackItem - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- fallbackItem() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the frame item painted into page slots not covered by an element.
- fallbackItem(Function<ViewContext, ItemStack>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- fallbackItem(Function<ViewContext, ItemStack>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets the item painted into page slots not covered by an element (for example the tail of a short last page) and into slots whose element failed on its very first paint.
- fillPage(List<RenderedItem>, Layout) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
- fillPage(List<RenderedItem>, Layout) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationHost
-
Applies one engine frame: item
iis mapped ontolayout.slots().get(i). - find(Class<? extends View>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.ViewRegistry
-
Looks up the registration of a view class.
- find(UUID) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.SessionRegistry
-
Looks up the session of a player.
- firstRender(ViewSession) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.FirstRenderPhase
-
Renders and shows a freshly opened session produced by
OpenPhase.openSession(org.bukkit.entity.Player, tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.RegisteredView, tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments). - FirstRenderPhase - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
-
Second half of the open pipeline:
onFirstRender, component materialization, initial paint, session registration, container show, activation and update-task start. - FirstRenderPhase(ViewEngine, SessionRegistry, SlotPainter) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.FirstRenderPhase
-
Creates the phase.
- flushDirty(ViewSession) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Flushes dirty state tokens of a session: each pass drains the dirty set and runs a STATE_CHANGE update over the watchers; passes repeat while handlers re-dirty tokens, capped at 8 cascades per flush, after which the remaining dirty tokens are dropped with a WARNING.
- flushHook(Runnable) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
-
Wires the engine flush callback invoked after every
SharedStateImpl.set(T); assigned once by the engine on the view's first open. - flushHookWired() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
-
Returns
trueif the engine has already wired a flush hook on this token. - flushShared(View) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Runs a full STATE_CHANGE repaint pass on every active session of the given view; full-pass fallback — the wired hooks use the watcher-scoped overload.
- frameSlots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the empty-state and loading frame slots this binding paints into, de-duplicated.
- freeze() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.TokenTable
-
Freezes this table; further
TokenTable.register(StateToken)calls throw.
G
- geometry() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the page geometry.
- get() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
- get() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.state.SharedState
-
Returns the current shared value.
- get(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateStore
-
Returns the stored value for a token id.
- get(String, Class<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Returns the value bound to the given key, or
nullwhen absent. - get(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
- get(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.LazyStateImpl
- get(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.MutableStateImpl
- get(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.state.State
-
Reads this token's value for the given context.
- getCurrentPage() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns the current page.
- getItemPageLimit() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns the page capacity.
- getOffset() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Returns the global element offset of the first item on the requested page — together with
PageRequest.getPageSize()the authoritative query bound:LIMIT pageSize OFFSET offset. - getPage() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Returns the 1-indexed page being requested.
- getPageOfIndex(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- getPageOfIndex(int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Maps a global source index onto the page it appears on.
- getPageOfIndex(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- getPageOfIndex(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- getPageSize() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Returns the maximum number of items the requested page can display.
- getTotalElements() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- getTotalElements() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns the element count of the current source.
- getTotalPages() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- getTotalPages() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns the page count of the current source.
- getTotalPages() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- getTotalPages() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- GridSlotsLayout - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.layout
-
Grid-parsed
LayoutbackingLayout.ofGrid(java.lang.String...):' 'is empty, every other character is a fill slot ordered by character code point (Unicode value), then occurrence. - GridSlotsLayout(String...) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.GridSlotsLayout
-
Parses the given grid rows into an ordered fill sequence.
H
- handlerFor(ClickType) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
-
Resolves the handler for a click: the matching per-type handler, else the untyped default handler, else null.
- HandlerInvoker - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal
-
Reflective dispatcher for the protected
Viewlifecycle handlers. - has(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Returns whether a value is bound to the given key.
- hasChar(char) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.ResolvedLayout
- hasDirty() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateStore
-
Returns whether any token id is currently marked dirty.
- hasNextPage() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- hasNextPage() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns whether forward navigation is possible.
- hasPendingNavigation() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns whether a pre-init navigation was recorded.
- hasPreviousPage() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- hasPreviousPage() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns whether backward navigation is possible.
- host - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
I
- id() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
-
Returns the table-assigned token id, the index into the per-session state store.
- id() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
-
Returns the table-assigned token id, the index into the per-session state store.
- id() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.LazyStateImpl
-
Returns the table-assigned token id, the index into the per-session state store.
- id() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.MutableStateImpl
-
Returns the table-assigned token id, the index into the per-session state store.
- id() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
-
Returns the table-assigned token id.
- IdentifiableToken - Interface in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Internal seam exposing the table-assigned int id of a state token.
- init(ViewSession) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.PaginationInitPhase
-
Initializes every pagination binding of the session.
- initialize(Context) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.ViewRegistry
-
Discovers
@RegisterViewclasses under the host plugin's base package, instantiates each through the dependency manager and registers it. - initialize(ResolvedLayout, ViewConfig) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Builds the per-context runtime: resolves and validates the fill target, creates the per-context page source and the geometry engine, replays any pending navigation on the still-unbound paginator (the preserved 2.x record-only branch) and binds the engine to this host — which dispatches the initial page load.
- initialState(String, Class<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares a mutable value bound from
ViewArgumentsat open; the type is validated at the open site. - InitialStateImpl<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Mutable state token bound from
ViewArgumentsat open: the open phase validates the argument type and writes the value straight into the session'sStateStore. - InitialStateImpl(View, TokenTable, String, Class<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
-
Creates and registers the token.
- initNavigationState() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- initNavigationState() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- initNavigationState() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- inline() - Static method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.SettleDispatcher
- insertPageItems() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- insertPageItems() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Paints the items of the current page through
PaginationHost.fillPage(java.util.List<tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem>, tech.guilhermekaua.spigotboot.inventoryapi.layout.Layout). - instance() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.RegisteredView
-
Returns the view singleton.
- invalidate() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- invalidate() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
-
Clears any cached pages.
- inventory() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the top container of this session.
- inventory() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- inventory() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- inventory() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the top container of this session.
- inventory(Inventory) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Sets the top container once it is created.
- InventoryApiAutoConfiguration - Class in tech.guilhermekaua.spigotboot.inventoryapi.config
-
Default beans for the inventory module.
- InventoryApiAutoConfiguration() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.config.InventoryApiAutoConfiguration
- InventoryApiModule - Class in tech.guilhermekaua.spigotboot.inventoryapi
-
Bootstraps the inventory-api view engine: initializes the
ViewRegistry, which discovers and registers everyRegisterView-annotatedViewsubclass under the host plugin's base package and instantiates each through the dependency manager. - InventoryApiModule() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.InventoryApiModule
- invoke(Method, View, Object) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Invokes a cached handler on a view, unwrapping
InvocationTargetExceptionso the handler's own failure surfaces: unchecked throwables are rethrown as-is and checked ones are wrapped inIllegalStateException. - isActive() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns whether this session is currently active (open, not transitioning or closed).
- isActive() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- isActive() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
- isActive() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationHost
-
Returns whether the bound session is currently paintable.
- isActive() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns whether this session is currently active.
- isAsync() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Returns whether this is an async declaration — the gate for the async-only builder options.
- isCancelled() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Returns the current cancellation decision: config/component policy applied before handlers run, possibly overturned by
SlotClickContext.setCancelled(boolean). - isCancelled() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- isCurrentPageEmpty() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- isCurrentPageEmpty() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Reports whether the most recently settled page rendered no elements.
- isFailure() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem
-
Returns whether this output is the failure sentinel.
- isFrozen() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.TokenTable
-
Returns whether
TokenTable.freeze()was called. - isInClickDispatch() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Returns whether a click event is currently being dispatched (drives operation deferral).
- isInitialized() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns whether
PaginationBinding.initialize(tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.ResolvedLayout, tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig)completed and the geometry engine is bound. - isLoading() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- isLoading() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns the in-flight state of the source.
- isLoading() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- isLoading() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- isLoading() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
- isLoading(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- isLoading(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns whether the latest page request has not settled yet.
- isOpenCancelled() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.OpenContext
-
Returns whether
OpenContext.cancelOpen()was called for this open. - isOpenCancelled() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- isPlayerInventory() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Returns whether the click landed in the player's own (bottom) inventory.
- isPlayerInventory() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- isVisible(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
-
Evaluates the
displayIfpredicate; visible by default. - item() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Returns the item on the clicked slot, if any.
- item() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- item(Function<ViewContext, ItemStack>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Sets a dynamic item renderer, re-evaluated on every re-render of this component.
- item(Function<ViewContext, ItemStack>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- item(ItemStack) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Sets a static item for this component.
- item(ItemStack) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- ItemComponentBuilder - Interface in tech.guilhermekaua.spigotboot.inventoryapi.component
-
Fluent declaration of one item component, returned by
RenderContext.slot(...)/layoutSlot(...). - ItemComponentBuilderImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.component
-
Mutable collector behind
ItemComponentBuilder; gathers a component declaration and materializes it into an immutableComponentInstancebound to fixed slots. - ItemComponentBuilderImpl() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- itemFactory - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- itemPageLimit - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- itemRenderer(PaginationItemRenderer<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- itemRenderer(PaginationItemRenderer<T>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets the per-element renderer.
K
- key() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
-
Returns the
ViewArgumentskey this token binds at open. - kind() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Returns the source kind.
L
- lastError() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- lastError() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns the most recent load failure.
- lastError() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- lastError() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- lastError() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
- lastError(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- lastError(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns the failure of the most recently settled page load, or
null; cleared when a new request is dispatched. - layout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns the layout rows declared in
onInit. - layout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the resolved layout of this session.
- layout(String...) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Sets the layout rows; each row must be non-null and exactly
Layout.ROW_WIDTHcharacters, validated atViewConfigBuilder.build(). - layout(ResolvedLayout) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Sets the resolved layout.
- layout(Layout) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- layout(Layout) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets an explicit fill order, silently overriding
PaginationBuilder.layoutChar(char). - Layout - Interface in tech.guilhermekaua.spigotboot.inventoryapi.layout
-
An ordered sequence of inventory slot positions used as a fill order, created from an ASCII grid (
Layout.ofGrid(java.lang.String...)) or from explicit slot indices (Layout.ofSlots(int...)). - LAYOUT_CHAR - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Target
-
All slots of one character of the view's layout, row-major.
- layoutChar() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the target layout character, meaningful only when
PaginationSpec.target()isPaginationSpec.Target.LAYOUT_CHAR. - layoutChar(char) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- layoutChar(char) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Targets every slot of the given character in the view's layout, in row-major order.
- layoutSlot(char) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.RenderContext
-
Starts one component applied to every slot bound to the given layout character.
- layoutSlot(char) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
- layoutSlot(char, ItemStack) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.RenderContext
-
Starts a layout-character component with a static item already set.
- layoutSlot(char, ItemStack) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
- lazy(Function<ViewContext, List<T>>) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Declares a lazy eager source:
sourceruns once per context at initialization (and again onPagination.refresh), each result wrapped in a freshEagerPageSource. - lazyFunction() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec
-
Returns the lazy list function, used by the
Pagination.refreshpath to re-evaluate the source. - lazyState(Function<ViewContext, T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares a read-only value computed once per context on the first read, on the main thread, and stored thereafter.
- LazyStateImpl<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Read-only state token computed once per context on the first read and stored in the session's
StateStore; anullresult is cached via a private sentinel so the computation never re-runs for that context. - LazyStateImpl(View, TokenTable, Function<ViewContext, T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.LazyStateImpl
-
Creates and registers the token.
- load(PageRequest) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSupplier
-
Loads the requested page.
- loadingItem - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- loadingItem() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the frame item painted into every page slot while an async load is in flight.
- loadingItem(Function<ViewContext, ItemStack>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- loadingItem(Function<ViewContext, ItemStack>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets the item painted into every page slot while an async load is in flight.
- loadingItem(Function<ViewContext, ItemStack>, int...) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- loadingItem(Function<ViewContext, ItemStack>, int...) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets the loading item painted only into the given slots while an async load is in flight, leaving every other layout slot empty.
- loadingOrFallback() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- loadingSlots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the absolute slots the loading item paints into.
- logger - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
-
Named after the concrete class so warnings point at the actual pagination type.
M
- markDirty(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateStore
-
Marks a token id dirty for the next flush; duplicate marks coalesce.
- materialize(int[]) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
-
Freezes the collected declaration into a component bound to the given slots.
- materializeAll() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
-
Materializes every collected declaration into the session's component table, in declaration order; the table validates slot overlaps and missing item sources.
- mutableState(Function<ViewContext, T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares a per-context mutable value whose initial is computed per context on first read, e.g.
- mutableState(T) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares a per-context mutable value seeded with a shared initial value.
- MutableState<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.state
-
Mutable per-context state.
- MutableStateImpl<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Mutable per-context state token; values live in the session's
StateStore. - MutableStateImpl(View, TokenTable, Function<ViewContext, T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.MutableStateImpl
-
Creates and registers the token.
N
- navigationSnapshot() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- navigationSnapshot() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- navigationSnapshot() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- nextPage() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- nextPage() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Advances to the next page if one exists.
- NoopPlaceholderApplier - Class in tech.guilhermekaua.spigotboot.inventoryapi.placeholder
-
Fallback
PlaceholderApplierthat returns the input text unchanged. - NoopPlaceholderApplier() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.placeholder.NoopPlaceholderApplier
- NORMAL - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Geometry
-
Page-by-page: page
pserves elements(p-1)*limit .. p*limit-1. - NormalPagination<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine
-
Page-by-page paginator.
- NormalPagination(Supplier<RenderedItem>, PageItemFactory<T>, Layout) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
-
Creates an eager paginator over an initially empty source.
- NormalPagination(Supplier<RenderedItem>, PageItemFactory<T>, Layout, Supplier<RenderedItem>, PageSource<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
-
Creates a paginator over the given page source.
O
- of(String, Object) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Creates arguments containing a single entry.
- of(String, Object, String, Object) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Creates arguments containing two entries.
- of(ViewSession) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBindings
-
Returns the pagination bindings of a session in token-declaration order.
- of(List<T>, int) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageResult
-
Creates a page result.
- ofElement(ItemComponentBuilderImpl) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem
-
Creates a slot output backed by a user-declared page element.
- ofGrid(String...) - Static method in interface tech.guilhermekaua.spigotboot.inventoryapi.layout.Layout
-
Parses a row-by-row ASCII grid:
' 'marks an empty slot, every other character is a fill slot; fill order is by character code point (Unicode value), then occurrence order. - ofItem(ItemStack) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem
-
Creates a plain frame item: a loading frame, a fallback filler or a slot clear.
- ofSlots(int...) - Static method in interface tech.guilhermekaua.spigotboot.inventoryapi.layout.Layout
-
Creates a layout that fills slots in exactly the given order.
- ON_CLICK - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Cached handle of
View.onClick(SlotClickContext). - ON_CLOSE - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Cached handle of
View.onClose(CloseContext). - ON_FIRST_RENDER - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Cached handle of
View.onFirstRender(RenderContext). - ON_INIT - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Cached handle of
View.onInit(ViewConfigBuilder). - ON_OPEN - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Cached handle of
View.onOpen(OpenContext). - ON_UPDATE - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.HandlerInvoker
-
Cached handle of
View.onUpdate(UpdateContext). - onClick(Consumer<SlotClickContext>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Sets the untyped click handler; it runs only when no per-
ClickTypehandler matched the click. - onClick(Consumer<SlotClickContext>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- onClick(ClickType, Consumer<SlotClickContext>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Sets the handler for one specific click type; it takes precedence over the untyped handler.
- onClick(ClickType, Consumer<SlotClickContext>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- onClick(SlotClickContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
View-level click fallback: runs after component handlers for top-container clicks and receives every bottom-inventory click with
isPlayerInventory() == true. - onClick(InventoryClickEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.listener.ViewListener
-
Routes inventory clicks of players with an open view session into the engine.
- onClose(CloseContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Called when the session tears down, with the matching
CloseReason. - onClose(InventoryCloseEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.listener.ViewListener
-
Bridges container closes into the engine; the engine guards by container identity.
- onDisable() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.InventoryApiModule
-
Shuts the shared pagination timeout scheduler down when the host plugin disables.
- onDrag(InventoryDragEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.listener.ViewListener
-
Applies the session drag policy to drags of players with an open view session.
- onError(PaginationErrorCallback) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- onError(PaginationErrorCallback) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Sets the callback invoked when an async page load fails.
- onError(PageRequest, Throwable) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PaginationErrorCallback
-
Handles a failed page load.
- onFirstRender(RenderContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares this session's components; called once per open, after the container is created and before the first paint.
- onInit(ViewConfigBuilder) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Configures this view; called once per class at registration.
- onInitialize(Context) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.InventoryApiModule
- onOpen(OpenContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Called once per open, before any container exists.
- onPluginDisable(PluginDisableEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.listener.ViewListener
-
Closes every open session when the plugin owning the inventory-api runtime disables.
- onQuit(PlayerQuitEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.listener.ViewListener
-
Closes the quitting player's session with the DISCONNECT reason.
- onUpdate(UpdateContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Called on every update pass; inspect
UpdateContext.trigger()for the cause. - open(Player, Class<? extends View>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewService
-
Opens a registered view for the player without arguments.
- open(Player, Class<? extends View>, ViewArguments) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Opens a registered view for a player, replacing any previous session at the commit point (spec §7).
- open(Player, Class<? extends View>, ViewArguments) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewService
-
Opens a registered view for the player with the given arguments.
- OPEN_FAILED - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
onFirstRenderthrew and the open was aborted before the container was shown. - OpenContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Context for
View.onOpen: runs before any container exists. - OpenContextImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Context for
View.onOpen: records per-open overrides and the cancel decision. - OpenContextImpl(ViewSession, ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
-
Creates the context for one open attempt.
- OPENING - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession.Status
-
The open phase is running; no container is shown yet.
- openOnClick(Class<? extends View>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Navigates to another registered view after a click on this component; deferred to the end of the tick.
- openOnClick(Class<? extends View>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- openOnClick(Class<? extends View>, ViewArguments) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Same as
ItemComponentBuilder.openOnClick(Class), passing arguments to the target view. - openOnClick(Class<? extends View>, ViewArguments) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- openOnClickArguments() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
- openOnClickTarget() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
- OpenPhase - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
-
First half of the open pipeline (spec §7.2-7.6): session and store creation, initial-state binding,
onOpenwith cancellation, previous-session replacement, per-open config merge, layout resolution and container creation. - OpenPhase(ViewEngine, SessionRegistry, SlotPainter) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.OpenPhase
-
Creates the phase.
- openSession(Player, RegisteredView, ViewArguments) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.OpenPhase
-
Opens a session up to (and including) container creation; first render and registration happen in
FirstRenderPhase. - openView(Class<? extends View>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Navigates to another registered view: this session closes with
CloseReason.REPLACED, then the target opens. - openView(Class<? extends View>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- openView(Class<? extends View>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
- openView(Class<? extends View>, ViewArguments) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Same as
ViewContext.openView(Class), passing arguments to the target view. - openView(Class<? extends View>, ViewArguments) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- openView(Class<? extends View>, ViewArguments) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
- OrderedSlotsLayout - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.layout
-
Explicit-order
LayoutbackingLayout.ofSlots(int...): the i-th given index is the i-th fill position. - OrderedSlotsLayout(int...) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.OrderedSlotsLayout
-
Creates a layout that fills slots in exactly the given order.
- overriddenRows() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
-
Returns the per-open rows override recorded in
onOpen. - overriddenTitle() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
-
Returns the per-open title override recorded in
onOpen. - overrideRows(int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.OpenContext
-
Overrides the configured row count for this open only.
- overrideRows(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- overrideTitle(String) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.OpenContext
-
Overrides the configured title for this open only.
- overrideTitle(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- owner() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- owner() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateBackedContext
-
Returns the view singleton owning this context, used for foreign-token checks.
P
- PageItemFactory<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine
-
Creates the
RenderedItemfor one element of the current page; supplied by the pagination binding so the engine stays free of renderer concerns. - PageRequest - Class in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Immutable description of one page load issued by a paginator; safe to share across threads.
- PageRequest(int, int, int, UUID, Plugin, Player) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Creates a page request.
- PageResult<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Immutable outcome of one page load: the page's items plus the total number of elements in the backing store, which drives
getTotalPages()and navigation clamping. - pageSource - Variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- PageSource<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Strategy answering "where do page items come from" for a paginator.
- paginate(Function<ViewContext, List<T>>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares paginated rendering over a per-context element list: the function runs once per context at pagination initialization, on the main thread, and runs again for that context only when
Pagination.refresh(context)is called. - paginate(List<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares paginated rendering over a fixed element list.
- paginateAsync(AsyncPageSupplier<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares paginated rendering over an asynchronously loaded source: every context gets its own fresh
AsyncPageSourceat pagination initialization, so request ids, page caches, loading state and errors are never shared between viewers. - paginateSource(Function<ViewContext, PageSource<T>>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Escape hatch declaring paginated rendering over a custom
PageSource: the factory runs once per context at pagination initialization and must return the source instance serving exactly that context. - Pagination<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination
-
Reactive pagination token, declared once per view through the
View.paginate*factories and built byPaginationBuilder.build(). - PAGINATION_SETTLE - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateTrigger
-
A pagination page settled (success, failure or timeout).
- PaginationBinding - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
Per-(session, token) pagination runtime: records pre-init navigation, builds the per-context page source and geometry engine at open time, owns the page-element components of the current frame and implements the
PaginationHostseam the relocated engine paints and settles through. - PaginationBinding(PaginationSpec<?>, int, ViewSession, ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Creates the binding for one pagination token of one session.
- PaginationBindings - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
Static lookup helpers over a session's pagination bindings.
- PaginationBuilder<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination
-
Fluent declaration of one pagination token, returned by the
View.paginate*factories. - PaginationBuilderImpl<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
PaginationBuilderimplementation behindView.paginate*: collects the declaration fluently (value errors rejected at setter time), validates the combination atPaginationBuilderImpl.build(), resolves geometry and target, and constructs the registeredPaginationImpltoken. - PaginationBuilderImpl(View, TokenTable, PaginationSourceSpec<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
-
Creates a builder for one pagination declaration of a view.
- PaginationErrorCallback - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Invoked when an async page load fails (exceptional completion,
nullfuture, synchronous throw, or timeout). - PaginationHost - Interface in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
The world-facing seam the relocated pagination engine talks to instead of the 2.x
Viewer/InventoryEditorpair. - PaginationImpl<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
The
Paginationtoken implementation: a per-view singleton declared at view construction time whose per-context runtime lives in aPaginationBindingstored in this token's ownStateStoreslot. - PaginationImpl(View, TokenTable, PaginationSpec<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
-
Creates and registers the token; called by
PaginationBuilderImpl.build(), so registration happens at build time. - PaginationInitPhase - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
-
Pagination init step of the open pipeline (spec §7 step 7): initializes every pagination binding of a freshly opened session between layout resolution and
onFirstRender— target slots resolve against the session layout, the per-context page source is built, the geometry engine is constructed and pending navigation recorded duringonOpenis replayed. - PaginationInitPhase(ViewEngine, SessionRegistry) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.PaginationInitPhase
-
Creates the phase.
- PaginationItemRenderer<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination
-
Renders one element of the current page into a component builder.
- paginationSettle(ViewSession, int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Runs a pagination-settle update pass scoped to the settled token, then flushes any state the handlers dirtied.
- PaginationSourceSpec<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
Immutable source declaration of one pagination token: which of the four source kinds the view declared, and how to construct the
PageSourcefor one context. - PaginationSourceSpec.Kind - Enum Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
The four ways a view can declare where page elements come from.
- PaginationSpec<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
Immutable pagination declaration built by
PaginationBuilderImpl.build(): geometry, paint target, renderer and frame items, the source declaration, and the async plumbing consumed byPaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler). - PaginationSpec.Geometry - Enum Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
How elements are distributed across pages.
- PaginationSpec.Target - Enum Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
Where the page items are painted.
- paginator() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the bound geometry engine.
- Paginator<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine
-
Internal page-source geometry engine: navigation, page-load dispatch and frame painting over a
PaginationHost. - paint(Player, Inventory, int, ItemStack, boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.render.SlotPainter
-
Paints the slot: a null item clears it; otherwise a clone of the item is written, with placeholders applied to its display name and lore when requested.
- painter() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Returns the slot painter used by the rendering phases; pagination bindings paint their page frames through it.
- PapiPlaceholderApplier - Class in tech.guilhermekaua.spigotboot.inventoryapi.placeholder
-
PlaceholderApplierthat delegates to PlaceholderAPI when the plugin is enabled at runtime. - PapiPlaceholderApplier() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.placeholder.PapiPlaceholderApplier
- PATTERN - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Geometry
-
Cycled per-page slot patterns.
- PatternPagination<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine
-
Paginates a source list across one or more
Layoutpatterns, cycling through the patterns as the player pages forward. - PatternPagination(Supplier<RenderedItem>, PageItemFactory<T>, List<Layout>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
-
Creates an eager paginator over an initially empty source.
- PatternPagination(Supplier<RenderedItem>, PageItemFactory<T>, List<Layout>, Supplier<RenderedItem>, PageSource<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
-
Creates a paginator over the given page source.
- patterns() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the per-page patterns.
- patterns(Layout...) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- patterns(Layout...) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Switches to pattern geometry: page
ppaints into the slots of pattern(p - 1) % patterns.length, cycling through the given patterns. - PATTERNS - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Target
-
The cycled per-page patterns.
- pendingTarget() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the page navigation will land on once the binding initializes.
- placeholderApplier() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.InventoryApiAutoConfiguration
- PlaceholderApplier - Interface in tech.guilhermekaua.spigotboot.inventoryapi.placeholder
-
Resolves placeholder tokens in user-facing text (item display names, lore lines, titles).
- plainItem() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.RenderedItem
-
Returns the plain frame item carried by this output.
- PlainViewContextImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Plain phase-less context handed out by
ViewService.contextOf; adds nothing on top of the base context behavior. - PlainViewContextImpl(ViewSession, ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.PlainViewContextImpl
-
Creates the context for a live session.
- player() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the player viewing this session.
- player() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- player() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
- player() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationHost
-
Returns the live viewer the settle dispatcher uses to route the settle to the correct region thread.
- player() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the viewer of this session.
- PLAYER - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
The player closed the container themselves (e.g.
- playerId() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the unique id of
ViewContext.player(). - playerId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- playerId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
- playerId() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationHost
-
Returns the player pages are being loaded for; populates the slim
PageRequest. - playerId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Returns the unique id of the player the page is being loaded for.
- plugin() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the plugin that owns the inventory-api runtime.
- plugin() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- plugin() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Returns the plugin owning the inventory-api runtime.
- plugin() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
- plugin() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationHost
-
Returns the plugin that owns the view; asynchronously completed settles are scheduled through it.
- plugin() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Returns the plugin that owns the load.
- PLUGIN_DISABLE - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
The owning plugin is being disabled.
- previousPage() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- previousPage() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Returns to the previous page if one exists.
- put(String, Object) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments.Builder
-
Adds an entry, replacing any previous value for the same key.
R
- rawEvent() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Returns the underlying Bukkit event as an escape hatch.
- rawEvent() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- reason() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.CloseContext
-
Returns why this session is closing.
- reason() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
- recordSwitchTo(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Records a pre-init navigation target; consumed once by
PaginationBinding.initialize(tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.ResolvedLayout, tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig). - refresh() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- refresh() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Re-requests the current page, invalidating any cached copy first.
- refresh(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- refresh(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Forces a reload of the current page.
- refreshLazy(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Re-invokes a lazy eager source's function against the given context, replaces the paginator's source with a fresh eager source over the result and re-requests the current page (forced).
- register(ViewSession) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.SessionRegistry
-
Registers a session under its player's UUID, replacing any previous mapping.
- register(StateToken) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.TokenTable
-
Registers a token and assigns its id.
- register(View) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.ViewRegistry
-
Registers a view instance directly: freezes its token table, runs
onInitonce and validates the resulting config. - registered() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the registration of the opened view.
- RegisteredView - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.registry
-
Immutable registration record of one view class: the singleton instance and the frozen config its
onInitproduced at registration time. - RegisteredView(Class<? extends View>, View, ViewConfig) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.RegisteredView
-
Creates the registration record.
- RegisterView - Annotation Interface in tech.guilhermekaua.spigotboot.inventoryapi.annotation
-
Marks a
Viewsubclass for boot-time discovery and registration, after which it can be opened throughViewService#open(Player, Class). - render(ViewContext, ItemComponentBuilder, int, T) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationItemRenderer
-
Renders one page element.
- RENDER_FAILURE - Static variable in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
-
Identity sentinel returned by
ComponentInstance.renderForPaint(tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext)when evaluation failed: the caller must skip painting so the slot keeps its previous content. - RenderContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Context for
View.onFirstRender: declares this session's components. - RenderContextImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Context for
View.onFirstRender: collects component declarations in order and freezes them into the session's component table viaRenderContextImpl.materializeAll(), called by the first-render phase after the handler returns. - RenderContextImpl(ViewSession, ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
-
Creates the context for one first render.
- RenderedItem - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
-
One slot's worth of pagination engine output: a user-declared element builder, a plain frame item (a
nullitem clears the slot), or the failure sentinel that keeps the slot's previous content entirely. - renderer() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the per-element renderer.
- renderForPaint(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
-
Single paint entry point: returns null to clear the slot (hidden component), the
ComponentInstance.RENDER_FAILUREsentinel (compare by identity) when displayIf or the renderer threw, or the item to paint. - renderItem(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
-
Produces this component's item: the static item, or the renderer applied to the context.
- renderLayout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- renderLayout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- renderLayout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- repaint() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Repaints the whole pagination area from the engine's current frame.
- REPLACED - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
Another view was opened for the same player, replacing this session.
- replaceSource(PageSource<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- replaceSource(PageSource<T>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.Paginator
-
Swaps the backing source and clears the locally held items.
- request(PageRequest, BiConsumer<PageResult<T>, Throwable>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- request(PageRequest, BiConsumer<PageResult<T>, Throwable>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- request(PageRequest, BiConsumer<PageResult<T>, Throwable>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
-
Requests the page described by
request. - requestOffset() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- requestOffset() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- requestOffset() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- requestRender() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
- requestRender() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationHost
-
Requests a reactive settle pass for the owning token: the engine repaints the token's pagination area and every component watching the token.
- requestTimeout() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the async per-request timeout, consumed by
PaginationSourceSpec.createSource(ViewContext, PaginationSpec, tech.guilhermekaua.spigotboot.core.spigot.scheduler.PlatformScheduler). - requestTimeout(Duration) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- requestTimeout(Duration) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Enables a per-request timeout: a load exceeding it fails with a
TimeoutExceptionand follows the normal error path. - require(String, Class<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewArguments
-
Returns the value bound to the given key, failing when absent.
- resolve(ViewConfig) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.ResolvedLayout
-
Parses the layout rows of the given config; layout shape was already validated at build time.
- ResolvedLayout - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.layout
-
Parsed form of
ViewConfig.layout(): maps each named layout character to its container slots in row-major order;' 'marks an unnamed position and is skipped. - restoreNavigation(Integer) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.NormalPagination
- restoreNavigation(Integer) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
- restoreNavigation(PatternPagination.PatternState) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.PatternPagination
- route(ViewSession, InventoryClickEvent) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.ClickRoutingPhase
-
Routes a Bukkit click event into the session per the click policy.
- ROW_WIDTH - Static variable in interface tech.guilhermekaua.spigotboot.inventoryapi.layout.Layout
-
The width of a chest inventory row.
- rows() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns the resolved row count, explicit or inferred from the layout.
- rows() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.ResolvedLayout
- rows(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Sets the explicit row count; optional when a layout is present (inferred).
- run() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.schedule.ViewUpdateTask
S
- SCHEDULED - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateTrigger
-
Scheduled tick update configured via
ViewConfigBuilder.scheduleUpdate(long). - scheduler() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Returns the platform scheduler used by this engine.
- scheduleUpdate(long) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Schedules periodic updates; values
<= 0disable scheduling (the default). - scroll() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBuilderImpl
- scroll() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.PaginationBuilder
-
Switches to sliding-window geometry: each page slides the visible window by exactly one element instead of jumping a full page.
- SCROLL - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Geometry
-
Sliding window: each page slides the visible window by exactly one element.
- ScrollPagination<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine
-
Sliding-window paginator.
- ScrollPagination(Supplier<RenderedItem>, PageItemFactory<T>, Layout) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
-
Creates an eager paginator over an initially empty source.
- ScrollPagination(Supplier<RenderedItem>, PageItemFactory<T>, Layout, Supplier<RenderedItem>, PageSource<T>) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine.ScrollPagination
-
Creates a paginator over the given page source.
- session() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
-
Returns the session this context is bound to.
- SessionRegistry - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.session
-
Tracks the live view session of every player, keyed by player UUID (one open view per player); the v3 counterpart of the 2.x
ViewerRegistryas a DI-managed bean. - SessionRegistry() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.SessionRegistry
- set(int, Object) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateStore
-
Stores a value for a token id, replacing any previous value.
- set(ViewContext, T) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
- set(ViewContext, T) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.MutableStateImpl
- set(ViewContext, T) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.state.MutableState
-
Writes this token's value for the given context and marks watchers dirty.
- set(T) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
- set(T) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.state.SharedState
-
Atomically replaces the shared value and triggers a watcher flush for every open session of the owning view.
- setCancelled(boolean) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Overrides the cancellation decision for this click; last writer wins.
- setCancelled(boolean) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- SettleDispatcher - Interface in tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
-
Decides which thread runs the settle (state application + callback delivery) of an asynchronously completed page load.
- sharedState(T) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Declares one atomic value per view singleton, shared by all viewers and writable from any thread.
- SharedState<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.state
-
One value per view singleton, shared by all viewers; not context-keyed.
- SharedStateImpl<T> - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Shared state token: one atomic value per view singleton, readable and writable from any thread.
- SharedStateImpl(View, TokenTable, T) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
-
Creates and registers the token.
- shutdownSharedTimeoutScheduler() - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
-
Shuts the shared timeout scheduler down and clears it so the next timeout-bearing request lazily recreates a fresh one.
- size() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.TokenTable
-
Returns the number of registered tokens.
- slot() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.SlotClickContext
-
Returns the raw slot id of the clicked container.
- slot() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
- slot(int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.RenderContext
-
Starts a component bound to a single slot.
- slot(int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
- slot(int, int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.RenderContext
-
Starts a component bound to a single slot addressed by grid position.
- slot(int, int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
- slot(int, ItemStack) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.RenderContext
-
Starts a single-slot component with a static item already set.
- slot(int, ItemStack) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.RenderContextImpl
- SlotClickContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Context for component click handlers and
View.onClick: one instance per interceptedInventoryClickEvent. - SlotClickContextImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Context for component click handlers and
View.onClick: wraps one Bukkit click event. - SlotClickContextImpl(ViewSession, ViewEngine, InventoryClickEvent, boolean, boolean) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.SlotClickContextImpl
-
Creates the context for one intercepted click.
- SlotPainter - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.render
-
Writes item stacks into container slots, applying placeholders to display name and lore at paint time on a clone of the given item (mirrors the 2.x
InventoryEditorImplplaceholder behavior); the caller's item is never mutated. - SlotPainter(PlaceholderApplier) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.render.SlotPainter
- slots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
- slots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.GridSlotsLayout
- slots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.OrderedSlotsLayout
- slots() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.layout.Layout
-
Returns the slot positions in fill order.
- slotsOf(char) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.layout.ResolvedLayout
- source() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the source declaration.
- spec() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
-
Returns the immutable declaration this token was built from.
- StaleContextException - Exception in tech.guilhermekaua.spigotboot.inventoryapi.exception
-
Thrown when a state token is accessed through a context belonging to a different view class or to an already closed session.
- StaleContextException(String) - Constructor for exception tech.guilhermekaua.spigotboot.inventoryapi.exception.StaleContextException
-
Creates the exception with a detail message.
- StaleContextException(String, Throwable) - Constructor for exception tech.guilhermekaua.spigotboot.inventoryapi.exception.StaleContextException
-
Creates the exception with a detail message and cause.
- State<T> - Interface in tech.guilhermekaua.spigotboot.inventoryapi.state
-
Read access to a per-context value identified by this token.
- STATE_CHANGE - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateTrigger
-
Coalesced flush after one or more state tokens changed via
MutableStateorSharedState. - StateBackedContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Seam between state token impls and context implementations: a context exposing the session's state store, owning view and liveness.
- stateStore() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- stateStore() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the per-session state storage.
- stateStore() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateBackedContext
-
Returns the per-session state storage backing this context.
- StateStore - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Per-session state storage: an array indexed by token id plus the set of dirty token ids awaiting the next coalesced flush.
- StateStore(int) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.StateStore
-
Creates storage sized for a view's token table.
- StateToken - Interface in tech.guilhermekaua.spigotboot.inventoryapi.state
-
Marker for watchable per-view tokens; implemented by
Stateand pagination tokens. - status() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the current lifecycle status.
- status(ViewSession.Status) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Sets the lifecycle status; called only by the engine.
- storeFor(ViewContext, View) - Static method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.ContextStateAccess
-
Resolves the state store of a context after validating that the context belongs to the given owning view and is still open — the single guard shared by every per-context token implementation.
- switchTo(ViewContext, int) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- switchTo(ViewContext, int) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Switches to the given page.
T
- target() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec
-
Returns the paint target.
- targetSlots() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the slots this binding paints into: the fill layout's slots for normal and scroll geometry, the union of all pattern slots for pattern geometry.
- tech.guilhermekaua.spigotboot.generated - package tech.guilhermekaua.spigotboot.generated
- tech.guilhermekaua.spigotboot.inventoryapi - package tech.guilhermekaua.spigotboot.inventoryapi
-
The spigot-boot inventory framework (3.0.0): view-based inventories with typed per-phase contexts, reactive state, and declarative pagination.
- tech.guilhermekaua.spigotboot.inventoryapi.annotation - package tech.guilhermekaua.spigotboot.inventoryapi.annotation
- tech.guilhermekaua.spigotboot.inventoryapi.component - package tech.guilhermekaua.spigotboot.inventoryapi.component
- tech.guilhermekaua.spigotboot.inventoryapi.config - package tech.guilhermekaua.spigotboot.inventoryapi.config
- tech.guilhermekaua.spigotboot.inventoryapi.context - package tech.guilhermekaua.spigotboot.inventoryapi.context
- tech.guilhermekaua.spigotboot.inventoryapi.exception - package tech.guilhermekaua.spigotboot.inventoryapi.exception
- tech.guilhermekaua.spigotboot.inventoryapi.internal - package tech.guilhermekaua.spigotboot.inventoryapi.internal
- tech.guilhermekaua.spigotboot.inventoryapi.internal.component - package tech.guilhermekaua.spigotboot.inventoryapi.internal.component
- tech.guilhermekaua.spigotboot.inventoryapi.internal.context - package tech.guilhermekaua.spigotboot.inventoryapi.internal.context
- tech.guilhermekaua.spigotboot.inventoryapi.internal.discovery - package tech.guilhermekaua.spigotboot.inventoryapi.internal.discovery
- tech.guilhermekaua.spigotboot.inventoryapi.internal.engine - package tech.guilhermekaua.spigotboot.inventoryapi.internal.engine
- tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase - package tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
- tech.guilhermekaua.spigotboot.inventoryapi.internal.layout - package tech.guilhermekaua.spigotboot.inventoryapi.internal.layout
- tech.guilhermekaua.spigotboot.inventoryapi.internal.listener - package tech.guilhermekaua.spigotboot.inventoryapi.internal.listener
- tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination - package tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination
- tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine - package tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.engine
- tech.guilhermekaua.spigotboot.inventoryapi.internal.registry - package tech.guilhermekaua.spigotboot.inventoryapi.internal.registry
- tech.guilhermekaua.spigotboot.inventoryapi.internal.render - package tech.guilhermekaua.spigotboot.inventoryapi.internal.render
- tech.guilhermekaua.spigotboot.inventoryapi.internal.schedule - package tech.guilhermekaua.spigotboot.inventoryapi.internal.schedule
- tech.guilhermekaua.spigotboot.inventoryapi.internal.session - package tech.guilhermekaua.spigotboot.inventoryapi.internal.session
- tech.guilhermekaua.spigotboot.inventoryapi.internal.state - package tech.guilhermekaua.spigotboot.inventoryapi.internal.state
- tech.guilhermekaua.spigotboot.inventoryapi.internal.util - package tech.guilhermekaua.spigotboot.inventoryapi.internal.util
- tech.guilhermekaua.spigotboot.inventoryapi.layout - package tech.guilhermekaua.spigotboot.inventoryapi.layout
- tech.guilhermekaua.spigotboot.inventoryapi.pagination - package tech.guilhermekaua.spigotboot.inventoryapi.pagination
- tech.guilhermekaua.spigotboot.inventoryapi.pagination.source - package tech.guilhermekaua.spigotboot.inventoryapi.pagination.source
- tech.guilhermekaua.spigotboot.inventoryapi.placeholder - package tech.guilhermekaua.spigotboot.inventoryapi.placeholder
- tech.guilhermekaua.spigotboot.inventoryapi.service - package tech.guilhermekaua.spigotboot.inventoryapi.service
- tech.guilhermekaua.spigotboot.inventoryapi.state - package tech.guilhermekaua.spigotboot.inventoryapi.state
- tech.guilhermekaua.spigotboot.inventoryapi.title - package tech.guilhermekaua.spigotboot.inventoryapi.title
- ThreadUtils - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.util
-
Shared threading assertions for the inventory-api internals.
- title() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns the inventory title (legacy color codes allowed).
- title(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
-
Sets the inventory title (legacy color codes allowed).
- titleUpdater() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.InventoryApiAutoConfiguration
- titleUpdater() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Returns the in-place title update strategy.
- TitleUpdater - Interface in tech.guilhermekaua.spigotboot.inventoryapi.title
-
Updates the title of the inventory currently open for a player without forcing the player to close and reopen the GUI.
- tokenId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationBinding
-
Returns the id of the pagination token this binding belongs to.
- tokenId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- tokenId() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.internal.state.IdentifiableToken
- tokenId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
- tokenId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.LazyStateImpl
- tokenId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.MutableStateImpl
- tokenId() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
- tokens() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.TokenTable
-
Returns the registered tokens in id order.
- tokenTable() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.View
-
Returns this view's token table; used by the engine to size per-session state storage and to freeze token registration.
- TokenTable - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.state
-
Per-view registry of state tokens.
- TokenTable() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.TokenTable
- totalElements() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- totalElements() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- totalElements() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
- totalElements(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- totalElements(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns the total element count of the backing source.
- totalPages(ViewContext) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationImpl
- totalPages(ViewContext) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.Pagination
-
Returns the total page count, always at least 1.
- totalsKnown() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.AsyncPageSource
- totalsKnown() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.EagerPageSource
- totalsKnown() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageSource
- TRANSITIONING - Enum constant in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession.Status
-
A deferred close or navigation is pending; further clicks are swallowed.
- trigger() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateContext
-
Returns what triggered this update pass.
- trigger() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.UpdateContextImpl
- type() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.RegisteredView
-
Returns the registered view class.
- type() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
-
Returns the expected argument type, validated at the open site.
U
- UnknownViewException - Exception in tech.guilhermekaua.spigotboot.inventoryapi.exception
-
Thrown when a view is opened (through ViewService.open or context navigation) but the target view class is not registered.
- UnknownViewException(String) - Constructor for exception tech.guilhermekaua.spigotboot.inventoryapi.exception.UnknownViewException
-
Creates the exception with a detail message.
- UnknownViewException(String, Throwable) - Constructor for exception tech.guilhermekaua.spigotboot.inventoryapi.exception.UnknownViewException
-
Creates the exception with a detail message and cause.
- unregister(ViewSession) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.SessionRegistry
-
Removes a session's mapping.
- update() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Runs a full update pass (
UpdateTrigger.EXPLICIT) synchronously:onUpdatefollowed by a component repaint. - update() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- update() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
- update() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- update(UnaryOperator<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.SharedStateImpl
- update(UnaryOperator<T>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.state.SharedState
-
Atomically updates the shared value with a compare-and-set loop;
fnmay run more than once under contention and must be side-effect free. - update(ViewContext, UnaryOperator<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.InitialStateImpl
- update(ViewContext, UnaryOperator<T>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.state.MutableStateImpl
- update(ViewContext, UnaryOperator<T>) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.state.MutableState
-
Read-modify-write convenience: applies
fnto the current value and stores the result. - update(ViewSession, UpdateTrigger) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Runs an update pass on a session, then flushes any state the handlers dirtied.
- update(ViewSession, UpdateTrigger, Set<Integer>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.UpdatePhase
-
Runs one update pass on a session.
- update(Player, String) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.title.TitleUpdater
-
Replaces the title shown on the inventory the player has open.
- UpdateContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Context for
View.onUpdate: fired by scheduled ticks, state flushes, explicit updates and pagination settles. - UpdateContextImpl - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.context
-
Context for
View.onUpdate: a plain context carrying the trigger of the pass. - UpdateContextImpl(ViewSession, ViewEngine, UpdateTrigger) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.UpdateContextImpl
-
Creates the context for one update pass.
- updateIntervalTicks() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns the scheduled update interval in ticks;
0means disabled. - updateOnStateChange(StateToken...) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.component.ItemComponentBuilder
-
Re-renders this component whenever one of the given tokens changes, at most once per flush.
- updateOnStateChange(StateToken...) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ItemComponentBuilderImpl
- UpdatePhase - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase
-
Update pass: invokes
View.onUpdatewith the trigger, then repaints components — all of them plus every pagination area on a full pass, or only the watchers of a dirty token set (plus dirty pagination areas and their element watchers) during a scoped flush. - UpdatePhase(ViewEngine, SlotPainter) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.phase.UpdatePhase
-
Creates the phase.
- updateTask() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Returns the scheduled update task of this session.
- updateTask(PlatformTask) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Sets or clears the scheduled update task.
- updateTitle(String) - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Updates the container title in place (no reopen) via the title updater: placeholders are applied for
ViewContext.player()when enabled by the view config, then legacy&color codes are translated. - updateTitle(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- updateTitle(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.CloseContextImpl
- updateTitle(String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.OpenContextImpl
- updateTitle(ViewSession, String) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Updates the container title of a session in place: placeholders are applied for the session's player when the effective config enables them, then legacy
&color codes are translated, and the result is handed to theTitleUpdater. - UpdateTrigger - Enum Class in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Why an update pass runs; exposed through
UpdateContext.trigger().
V
- valueOf(String) - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateTrigger
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Geometry
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Target
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession.Status
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.CloseReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.context.UpdateTrigger
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSourceSpec.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Geometry
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.pagination.PaginationSpec.Target
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- view() - Method in interface tech.guilhermekaua.spigotboot.inventoryapi.context.ViewContext
-
Returns the view singleton this context belongs to.
- view() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.context.AbstractViewContext
- View - Class in tech.guilhermekaua.spigotboot.inventoryapi
-
Base class for inventory views.
- View() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.View
- ViewArguments - Class in tech.guilhermekaua.spigotboot.inventoryapi.service
-
Immutable, typed key-value arguments passed to a view when it is opened.
- ViewArguments.Builder - Class in tech.guilhermekaua.spigotboot.inventoryapi.service
-
Mutable accumulator for
ViewArguments. - ViewConfig - Class in tech.guilhermekaua.spigotboot.inventoryapi.config
-
Immutable, validated view configuration produced by
ViewConfigBuilder.build(); frozen at registration and merged with per-open overrides viaViewConfig.withOverrides(java.lang.String, java.lang.Integer). - ViewConfigBuilder - Class in tech.guilhermekaua.spigotboot.inventoryapi.config
-
Fluent, mutable builder for
ViewConfig, used inView.onInit;ViewConfigBuilder.build()validates and freezes the configuration. - ViewConfigBuilder() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfigBuilder
- ViewConfigurationException - Exception in tech.guilhermekaua.spigotboot.inventoryapi.exception
-
Thrown at registration or build time when a view configuration, layout or component declaration violates a validation rule.
- ViewConfigurationException(String) - Constructor for exception tech.guilhermekaua.spigotboot.inventoryapi.exception.ViewConfigurationException
-
Creates the exception with a detail message.
- ViewConfigurationException(String, Throwable) - Constructor for exception tech.guilhermekaua.spigotboot.inventoryapi.exception.ViewConfigurationException
-
Creates the exception with a detail message and cause.
- ViewContext - Interface in tech.guilhermekaua.spigotboot.inventoryapi.context
-
Base contract shared by every per-phase context handed to
Viewlifecycle handlers. - ViewDiscoveryService - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.discovery
-
Finds every concrete
Viewsubclass annotated withRegisterViewunder the user's base package. - ViewDiscoveryService() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.discovery.ViewDiscoveryService
- ViewEngine - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.engine
-
Orchestrator of the view lifecycle: composes the fixed-order phase handlers and is the sole mutator of sessions.
- ViewEngine(Plugin, ViewRegistry, SessionRegistry, SlotPainter, TitleUpdater, PlatformScheduler) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.engine.ViewEngine
-
Creates the engine and its phase handlers.
- viewer() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.pagination.source.PageRequest
-
Returns the live viewer the settle dispatcher uses to route the settle to the correct region thread.
- ViewListener - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.listener
-
Single Bukkit listener bridge of the v3 view engine: resolves the clicking, dragging, closing, quitting or disabling player's session in the
SessionRegistryand delegates to the matchingViewEngineentry point. - ViewListener(SessionRegistry, ViewEngine) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.listener.ViewListener
-
Creates the listener.
- ViewRegistry - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.registry
-
Registry of view singletons and their frozen configs, keyed by view class.
- ViewRegistry() - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.ViewRegistry
-
Creates a registry without discovery support; views are registered directly through
ViewRegistry.register(View). - ViewRegistry(ViewDiscoveryService) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.registry.ViewRegistry
-
Creates the registry with discovery support.
- ViewService - Class in tech.guilhermekaua.spigotboot.inventoryapi.service
-
DI facade for opening and closing views.
- ViewService(ViewEngine, SessionRegistry) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.service.ViewService
-
Creates the service.
- ViewSession - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.session
-
Runtime state of one (player, open) pair: lifecycle status, container, effective config, resolved layout, component table, state storage and deferred end-of-tick operations.
- ViewSession(Player, RegisteredView, ViewArguments, StateStore) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.session.ViewSession
-
Creates a session in
ViewSession.Status.OPENING. - ViewSession.Status - Enum Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.session
-
Lifecycle status of a session.
- ViewUpdateTask - Class in tech.guilhermekaua.spigotboot.inventoryapi.internal.schedule
-
Per-session scheduled update runnable, started by the first-render phase when
updateIntervalTicks > 0and cancelled by the close phase. - ViewUpdateTask(ViewEngine, ViewSession) - Constructor for class tech.guilhermekaua.spigotboot.inventoryapi.internal.schedule.ViewUpdateTask
-
Creates the task for one session.
W
- watchedTokenIds() - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentInstance
- watchersOf(Set<Integer>) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.internal.component.ComponentTable
-
Resolves the components whose watched token ids intersect the dirty set, in declaration order.
- withOverrides(String, Integer) - Method in class tech.guilhermekaua.spigotboot.inventoryapi.config.ViewConfig
-
Returns a copy of this config with the given non-null per-open overrides applied; this instance is unchanged.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form