net.infumia.frame.typedkey

Interface TypedKeyStorage

All Superinterfaces:

TypedKeyStorageImmutable

public interface TypedKeyStorage
extends TypedKeyStorageImmutable

A typed key storage is a storage that is used to store values by typed keys.

Method Summary

Modifier and Type	Method and Description
<T> T	compute(@NotNull TypedKey<T> key, @NotNull java.util.function.Function<T,T> oldValueToNewValue) Computes a new value for the given key.
<T> T	computeIfAbsent(@NotNull TypedKey<T> key, @NotNull java.util.function.Supplier<T> valueSupplier) Computes a new value for the given key if the key is absent.
<T> T	computeIfPresent(@NotNull TypedKey<T> key, @NotNull java.util.function.Function<T,T> oldValueToNewValue) Computes a new value for the given key if the key is present.
<T> boolean	put(@NotNull TypedKey<T> key, T value) Puts a value into the storage.
<T> boolean	remove(@NotNull TypedKey<T> key) Removes a value from the storage.

Methods inherited from interface net.infumia.frame.typedkey.TypedKeyStorageImmutable

contains, entries, get, get, getOrThrow, getOrThrow, getUnchecked, getUncheckedOrThrow, keys, map, values

Method Detail

put

<T> boolean put(@NotNull
                @NotNull TypedKey<T> key,
                @NotNull
                T value)

Puts a value into the storage.

Parameters:

key - the key

value - the value

Returns:

true if the value was put, false otherwise

compute

@NotNull
<T> T compute(@NotNull
                       @NotNull TypedKey<T> key,
                       @NotNull
                       @NotNull java.util.function.Function<T,T> oldValueToNewValue)

Computes a new value for the given key.

Parameters:

key - the key

oldValueToNewValue - the function to compute the new value

Returns:

the new value

computeIfAbsent

@NotNull
<T> T computeIfAbsent(@NotNull
                               @NotNull TypedKey<T> key,
                               @NotNull
                               @NotNull java.util.function.Supplier<T> valueSupplier)

Computes a new value for the given key if the key is absent.

Parameters:

key - the key

valueSupplier - the supplier to compute the new value

Returns:

the new value

computeIfPresent

@Nullable
<T> T computeIfPresent(@NotNull
                                 @NotNull TypedKey<T> key,
                                 @NotNull
                                 @NotNull java.util.function.Function<T,T> oldValueToNewValue)

Computes a new value for the given key if the key is present.

Parameters:

key - the key

oldValueToNewValue - the function to compute the new value

Returns:

the new value

remove

<T> boolean remove(@NotNull
                   @NotNull TypedKey<T> key)

Removes a value from the storage.

Parameters:

key - the key

Returns:

true if the value was removed, false otherwise