space.vectrix.ignite.util

Class BlackboardMap

java.lang.Object

space.vectrix.ignite.util.BlackboardMap

public final class BlackboardMap
extends java.lang.Object

Represents a typed map.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlackboardMap.Key<T> Represents a key for a BlackboardMap.

Method Summary

Modifier and Type	Method and Description
static @NotNull BlackboardMap	create() Returns a new BlackboardMap.
<V> @NotNull java.util.Optional<V>	get(@NotNull BlackboardMap.Key<V> key) Returns the value associated with the given BlackboardMap.Key.
<V> void	put(@NotNull BlackboardMap.Key<V> key, V value) Sets the given value associated with the given BlackboardMap.Key.

Methods inherited from class java.lang.Object

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

Method Detail

create

@NotNull
public static @NotNull BlackboardMap create()

Returns a new BlackboardMap.

Returns:

a new blackboard map

Since:

1.0.0

get

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

Returns the value associated with the given BlackboardMap.Key.

Type Parameters:

V - the value type

Parameters:

key - the key

Returns:

the value

Since:

1.0.0

put

public <V> void put(@NotNull
                    @NotNull BlackboardMap.Key<V> key,
                    @Nullable
                    V value)

Sets the given value associated with the given BlackboardMap.Key.

Type Parameters:

V - the value type

Parameters:

key - the key

value - the value

Since:

1.0.0