me.devnatan.inventoryframework

Interface RootView

All Superinterfaces:

VirtualView

public interface RootView
extends VirtualView

Method Summary

Modifier and Type	Method and Description
@NotNull ViewConfig	getConfig() The configuration for this view.
@NotNull ElementFactory	getElementFactory() The ElementFactory for this view.
@UnmodifiableView java.util.Set<IFContext>	getInternalContexts() All contexts linked to this view.
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getMetadata()
@NotNull Pipeline<VirtualView>	getPipeline() The execution pipeline for this view.
Job	getScheduledUpdateJob() This is an internal inventory-framework API that should not be used from outside of this library.
@NotNull java.util.UUID	getUniqueId() The unique identifier of this view.
void	nextTick(java.lang.Runnable task) Runs a task in the next tick.
void	setConfig(@NotNull ViewConfig config) Sets the configuration for this view.
void	setScheduledUpdateJob(@NotNull Job job) This is an internal inventory-framework API that should not be used from outside of this library.

Method Detail

getUniqueId

@NotNull
@NotNull java.util.UUID getUniqueId()

The unique identifier of this view.

Returns:

The unique id of this view.

getInternalContexts

@ApiStatus.Internal
@UnmodifiableView java.util.Set<IFContext> getInternalContexts()

All contexts linked to this view.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Returns:

An unmodifiable set of all currently active contexts in this view.

getConfig

@NotNull
@NotNull ViewConfig getConfig()

The configuration for this view.

Returns:

The configuration for this view.

Throws:

java.lang.IllegalStateException - If the configuration is not available yet (uninitialized)

setConfig

void setConfig(@NotNull
               @NotNull ViewConfig config)

Sets the configuration for this view.

Parameters:

config - The new configuration of this view.

Throws:

java.lang.IllegalStateException - If the configuration was already set before.

getPipeline

@NotNull
@NotNull Pipeline<VirtualView> getPipeline()

The execution pipeline for this view.

Returns:

The pipeline for this view.

getElementFactory

@ApiStatus.Internal
 @NotNull
@NotNull ElementFactory getElementFactory()

The ElementFactory for this view.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Returns:

The current element factory.

nextTick

@ApiStatus.Internal
void nextTick(java.lang.Runnable task)

Runs a task in the next tick.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Parameters:

task - The task to run.

getScheduledUpdateJob

@ApiStatus.Internal
Job getScheduledUpdateJob()

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

setScheduledUpdateJob

@ApiStatus.Internal
void setScheduledUpdateJob(@NotNull
                                               @NotNull Job job)

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

getMetadata

@NotNull
@NotNull java.util.Map<java.lang.String,java.lang.Object> getMetadata()