jalse.actions

Interface ActionBindings

All Known Subinterfaces:

ActionContext<T>, SchedulableActionContext<T>

All Known Implementing Classes:

AbstractFutureActionContext, AbstractManualActionContext, DefaultActionBindings, ForkJoinActionEngine.ForkJoinContext, ManualActionEngine.ManualContext, ThreadPoolActionEngine.ThreadPoolContext

public interface ActionBindings

An immutable key-value bindings for ActionEngine (keys are strings).

Method Summary

Modifier and Type	Method and Description
default boolean	containsKey(java.lang.String key) Whether the bindings contains a mapping for the supplied key.
<T> T	get(java.lang.String key) Gets the value bound to the supplied key.
<T> T	put(java.lang.String key, T value) Binds the supplied key-value pair.
void	putAll(java.util.Map<java.lang.String,?> map) Binds all of the key-value pairs in the supplied map.
<T> T	remove(java.lang.String key) Removes the value bound to the supplied key.
void	removeAll() Removes all key-value pairs.
java.util.Map<java.lang.String,?>	toMap() Maps the key-values combinations.

Method Detail

containsKey

default boolean containsKey(java.lang.String key)

Whether the bindings contains a mapping for the supplied key.

Parameters:

key - Key to check.

Returns:

Whether there is a value associated to this key.

get

<T> T get(java.lang.String key)

Gets the value bound to the supplied key.

Parameters:

key - Key to check.

Returns:

Bound value or null if none found.

put

<T> T put(java.lang.String key,
          T value)

Binds the supplied key-value pair.

Parameters:

key - Key to bind value to.

value - Value to bind.

Returns:

Previously associated value or null if none were.

putAll

void putAll(java.util.Map<java.lang.String,?> map)

Binds all of the key-value pairs in the supplied map.

Parameters:

map - Key-value pairs to bind.

remove

<T> T remove(java.lang.String key)

Removes the value bound to the supplied key.

Parameters:

key - Key to check.

Returns:

Value that was bound to the key or else null if none were.

removeAll

void removeAll()

Removes all key-value pairs.

toMap

java.util.Map<java.lang.String,?> toMap()

Maps the key-values combinations.

Returns:

Map of bindings key-value combinations.