Package org.incendo.cloud.key

Class SimpleMutableCloudKeyContainer

java.lang.Object

org.incendo.cloud.key.SimpleMutableCloudKeyContainer

All Implemented Interfaces:

CloudKeyContainer, MutableCloudKeyContainer

@API(status=INTERNAL)
public final class SimpleMutableCloudKeyContainer
extends Object
implements MutableCloudKeyContainer

Constructor Summary

Constructors

Constructor	Description
SimpleMutableCloudKeyContainer(Map<CloudKey<?>,Object> map)	Creates a new SimpleMutableCloudKeyContainer.

Method Summary

Modifier and Type	Method	Description
@NonNull Map<CloudKey<?>,? extends @NonNull Object>	all()	Returns all stored values.
<V> V	computeIfAbsent(@NonNull CloudKey<V> key, @NonNull Function<@NonNull CloudKey<V>,V> defaultFunction)	Returns the value associated with the given key if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.
boolean	contains(@NonNull CloudKey<?> key)	Returns whether the registry contains a value associated with the given key.
<V> @Nullable V	getOrNull(CloudKey<V> key)	Get the value, or null if not present, without boxing in an optional.
<V> @NonNull Optional<V>	optional(@NonNull String key)	Returns the value associated with the given key.
<V> @NonNull Optional<V>	optional(@NonNull CloudKey<V> key)	Returns the value associated with the given key.
void	remove(@NonNull CloudKey<?> key)	Removes value associated with the given key.
<V> void	store(@NonNull String key, @NonNull V value)	Stores the key-value pair.
<V> void	store(@NonNull CloudKey<V> key, @NonNull V value)	Stores the key-value pair.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.key.CloudKeyContainer

contains, contains, get, get, get, getOrDefault, getOrDefault, getOrDefault, getOrSupplyDefault, getOrSupplyDefault, getOrSupplyDefault, optional

Methods inherited from interface org.incendo.cloud.key.MutableCloudKeyContainer

computeIfAbsent, remove, remove, set, set, set, store

Constructor Details

SimpleMutableCloudKeyContainer

public SimpleMutableCloudKeyContainer(Map<CloudKey<?>,Object> map)

Creates a new SimpleMutableCloudKeyContainer.

Parameters:

map - backing map

Method Details

optional

public <V> @NonNull Optional<V> optional(@NonNull CloudKey<V> key)

Description copied from interface: CloudKeyContainer

Returns the value associated with the given key.

Specified by:

optional in interface CloudKeyContainer

Type Parameters:

V - the type of the value

Parameters:

key - the key

Returns:

the value

optional

public <V> @NonNull Optional<V> optional(@NonNull String key)

Description copied from interface: CloudKeyContainer

Returns the value associated with the given key.

Specified by:

optional in interface CloudKeyContainer

Type Parameters:

V - the type of the value

Parameters:

key - the key

Returns:

the value

contains

public boolean contains(@NonNull CloudKey<?> key)

Description copied from interface: CloudKeyContainer

Returns whether the registry contains a value associated with the given key.

Specified by:

contains in interface CloudKeyContainer

Parameters:

key - the key

Returns:

true if the value exists, or false if it does not

all

public @NonNull Map<CloudKey<?>,? extends @NonNull Object> all()

Description copied from interface: CloudKeyContainer

Returns all stored values.

Specified by:

all in interface CloudKeyContainer

Returns:

immutable view of all values

store

public <V> void store(@NonNull CloudKey<V> key,
 @NonNull V value)

Description copied from interface: MutableCloudKeyContainer

Stores the key-value pair.

This will overwrite any existing value stored with the same key.

Specified by:

store in interface MutableCloudKeyContainer

Type Parameters:

V - the type of the value

Parameters:

key - the key

value - the value

store

public <V> void store(@NonNull String key,
 @NonNull V value)

Description copied from interface: MutableCloudKeyContainer

Stores the key-value pair.

This will overwrite any existing value stored with the same key.

Specified by:

store in interface MutableCloudKeyContainer

Type Parameters:

V - the type of the value

Parameters:

key - the key

value - the value

remove

public void remove(@NonNull CloudKey<?> key)

Description copied from interface: MutableCloudKeyContainer

Removes value associated with the given key.

Specified by:

remove in interface MutableCloudKeyContainer

Parameters:

key - the key

computeIfAbsent

public <V> V computeIfAbsent(@NonNull CloudKey<V> key,
 @NonNull Function<@NonNull CloudKey<V>,V> defaultFunction)

Description copied from interface: MutableCloudKeyContainer

Returns the value associated with the given key if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.

Specified by:

computeIfAbsent in interface MutableCloudKeyContainer

Type Parameters:

V - the type of the value

Parameters:

key - the key

defaultFunction - the function used to generate the value in case it's missing

Returns:

the present or computed value

getOrNull

public <V> @Nullable V getOrNull(CloudKey<V> key)

Get the value, or null if not present, without boxing in an optional.

Type Parameters:

V - value type

Parameters:

key - key

Returns:

value or null