me.lucko.helper.js.exports

Interface ScriptExportRegistry

public interface ScriptExportRegistry

A registry for script object state.

All scripts are stateless, so data which needs to persist between reloads must be saved to the export registry.

The same export registry is shared between scripts using the same SystemScriptBindings.

Method Summary

Modifier and Type	Method and Description
static ScriptExportRegistry	create()
default <T> T	get(String key) Gets an export handle, if present
default <T> T	get(String key, Supplier<T> other) Gets or initializes a new export, and sets it to the given value if empty
default <T> T	get(String key, T other) Gets or initializes a new export, and sets it to the given value if empty
Collection<ScriptExport<?>>	getExports() Gets all exports in this registry
<T> ScriptExport<T>	handle(String key) Produces and returns a script export handle
default <T> ScriptExport<T>	handle(String key, Supplier<T> defaultValue) Produces and returns a script export handle
default <T> ScriptExport<T>	handle(String key, T defaultValue) Produces and returns a script export handle
boolean	has(String key) Gets if this export registry has a certain export
void	remove(String key) Removes an export from this registry.
default <T> ScriptExport<T>	set(String key, T value) Gets or initializes a new export, and sets it to the given value

Method Detail

create

@Nonnull
static ScriptExportRegistry create()

handle

@Nonnull
<T> ScriptExport<T> handle(@Nonnull
                                     String key)

Produces and returns a script export handle

Type Parameters:

T - the export type

Parameters:

key - the key of the handle

Returns:

the handle

handle

@Nonnull
default <T> ScriptExport<T> handle(@Nonnull
                                             String key,
                                             T defaultValue)

Produces and returns a script export handle

Type Parameters:

T - the export type

Parameters:

key - the key of the handle

defaultValue - the value to populate the handle with if empty

Returns:

the handle

handle

@Nonnull
default <T> ScriptExport<T> handle(@Nonnull
                                             String key,
                                             Supplier<T> defaultValue)

Produces and returns a script export handle

Type Parameters:

T - the export type

Parameters:

key - the key of the handle

defaultValue - the value to populate the handle with if empty

Returns:

the handle

get

@Nullable
default <T> T get(@Nonnull
                             String key)

Gets an export handle, if present

Type Parameters:

T - the export type

Parameters:

key - the key of the handle

Returns:

the export, or null

get

default <T> T get(@Nonnull
                  String key,
                  T other)

Gets or initializes a new export, and sets it to the given value if empty

Type Parameters:

T - the export type

Parameters:

key - the handle key

other - the value to populate the handle with if empty

Returns:

the export

get

default <T> T get(@Nonnull
                  String key,
                  @Nonnull
                  Supplier<T> other)

Gets or initializes a new export, and sets it to the given value if empty

Type Parameters:

T - the export type

Parameters:

key - the handle key

other - the value to populate the handle with if empty

Returns:

the export

set

@Nonnull
default <T> ScriptExport<T> set(@Nonnull
                                          String key,
                                          T value)

Gets or initializes a new export, and sets it to the given value

Type Parameters:

T - the export type

Parameters:

key - the handle key

value - the value to set

Returns:

the handle

has

boolean has(@Nonnull
            String key)

Gets if this export registry has a certain export

Parameters:

key - the get of the export

Returns:

if the registry has an export

remove

void remove(@Nonnull
            String key)

Removes an export from this registry.

Parameters:

key - the export key

getExports

@Nonnull
Collection<ScriptExport<?>> getExports()

Gets all exports in this registry

Returns:

the exports in this registry