space.vectrix.ignite

Class Blackboard

java.lang.Object

space.vectrix.ignite.Blackboard

public final class Blackboard
extends java.lang.Object

Represents a map of startup flags.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static BlackboardMap.Key<java.lang.Boolean>	DEBUG
static BlackboardMap.Key<java.nio.file.Path>	GAME_JAR
static BlackboardMap.Key<java.nio.file.Path>	GAME_LIBRARIES
static BlackboardMap.Key<java.lang.String>	GAME_LOCATOR
static BlackboardMap.Key<java.lang.String>	GAME_TARGET
static BlackboardMap.Key<java.nio.file.Path>	MODS_DIRECTORY

Method Summary

Modifier and Type	Method and Description
static <T> void	compute(BlackboardMap.Key<T> key, @NotNull java.util.function.Supplier<T> supplier) Supplies the value associated with the BlackboardMap.Key.
static <T> @NotNull java.util.Optional<T>	get(BlackboardMap.Key<T> key) Returns the value associated with the BlackboardMap.Key.
static <T> BlackboardMap.Key<T>	key(@NotNull java.lang.String key, @NotNull java.lang.Class<? super T> type, T defaultValue) Returns a new BlackboardMap.Key for the given key, type and default value.
static <T> void	put(BlackboardMap.Key<T> key, T value) Sets the value associated with the BlackboardMap.Key.
static <T> T	raw(BlackboardMap.Key<T> key) Returns the value associated with the BlackboardMap.Key.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final BlackboardMap.Key<java.lang.Boolean> DEBUG

GAME_LOCATOR

public static final BlackboardMap.Key<java.lang.String> GAME_LOCATOR

GAME_JAR

public static final BlackboardMap.Key<java.nio.file.Path> GAME_JAR

GAME_TARGET

public static final BlackboardMap.Key<java.lang.String> GAME_TARGET

GAME_LIBRARIES

public static final BlackboardMap.Key<java.nio.file.Path> GAME_LIBRARIES

MODS_DIRECTORY

public static final BlackboardMap.Key<java.nio.file.Path> MODS_DIRECTORY

Method Detail

get

@NotNull
public static <T> @NotNull java.util.Optional<T> get(BlackboardMap.Key<T> key)

Returns the value associated with the BlackboardMap.Key.

Type Parameters:

T - the value type

Parameters:

key - the key

Returns:

the value

Since:

1.0.0

raw

public static <T> T raw(BlackboardMap.Key<T> key)

Returns the value associated with the BlackboardMap.Key.

Type Parameters:

T - the value type

Parameters:

key - the key

Returns:

the value

Since:

1.0.0

compute

public static <T> void compute(BlackboardMap.Key<T> key,
                               @NotNull
                               @NotNull java.util.function.Supplier<T> supplier)

Supplies the value associated with the BlackboardMap.Key.

Type Parameters:

T - the value type

Parameters:

key - the key

supplier - the supplier

Since:

1.0.0

put

public static <T> void put(BlackboardMap.Key<T> key,
                           @Nullable
                           T value)

Sets the value associated with the BlackboardMap.Key.

Type Parameters:

T - the value type

Parameters:

key - the key

value - the value

Since:

1.0.0

key

public static <T> BlackboardMap.Key<T> key(@NotNull
                                           @NotNull java.lang.String key,
                                           @NotNull
                                           @NotNull java.lang.Class<? super T> type,
                                           @Nullable
                                           T defaultValue)

Returns a new BlackboardMap.Key for the given key, type and default value.

Type Parameters:

T - the value type

Parameters:

key - the key

type - the type

defaultValue - the default value

Returns:

a new blackboard key

Since:

1.0.0