net.infumia.frame.typedkey

Interface TypedKeyStorageImmutable

All Known Subinterfaces:

TypedKeyStorage

public interface TypedKeyStorageImmutable

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

Method Summary

Modifier and Type	Method and Description
boolean	contains(@NotNull TypedKey<?> key) Checks if the storage contains a key.
@NotNull @UnmodifiableView java.util.Collection<java.util.Map.Entry<TypedKey<?>,java.lang.Object>>	entries() Gets the entries from the storage.
@Nullable java.lang.Object	get(@NotNull java.lang.String key) Gets a value from the storage.
<T> T	get(@NotNull TypedKey<T> key) Gets a value from the storage.
java.lang.Object	getOrDefault(@NotNull java.lang.String key, @Nullable java.lang.Object defaultValue)
<T> T	getOrDefault(@NotNull TypedKey<T> key, T defaultValue)
@NotNull java.lang.Object	getOrThrow(@NotNull java.lang.String key) Gets a value from the storage.
<T> T	getOrThrow(@NotNull TypedKey<T> key) Gets a value from the storage.
<T> T	getUnchecked(@NotNull java.lang.String key) Gets a value from the storage.
<T> T	getUncheckedOrThrow(@NotNull java.lang.String key) Gets a value from the storage.
@NotNull @UnmodifiableView java.util.Collection<TypedKey<?>>	keys() Gets the keys from the storage.
@NotNull @UnmodifiableView java.util.Map<TypedKey<?>,java.lang.Object>	map() Gets the map from the storage.
@NotNull @UnmodifiableView java.util.Collection<java.lang.Object>	values() Gets the values from the storage.

Method Detail

get

@Nullable
<T> T get(@NotNull
                    @NotNull TypedKey<T> key)

Gets a value from the storage.

Parameters:

key - the key

Returns:

the value

get

@Nullable
@Nullable java.lang.Object get(@NotNull
                                         @NotNull java.lang.String key)

Gets a value from the storage.

Parameters:

key - the key

Returns:

the value

getUnchecked

@Nullable
<T> T getUnchecked(@NotNull
                             @NotNull java.lang.String key)

Gets a value from the storage.

Parameters:

key - the key

Returns:

the value

getOrThrow

@NotNull
<T> T getOrThrow(@NotNull
                          @NotNull TypedKey<T> key)

Gets a value from the storage.

Parameters:

key - the key

Returns:

the value

getOrDefault

@Contract(value="_, null -> null; _, !null -> !null")
<T> T getOrDefault(@NotNull
                                                                         @NotNull TypedKey<T> key,
                                                                         @Nullable
                                                                         T defaultValue)

getOrThrow

@NotNull
@NotNull java.lang.Object getOrThrow(@NotNull
                                              @NotNull java.lang.String key)

Gets a value from the storage.

Parameters:

key - the key

Returns:

the value

getOrDefault

@Contract(value="_, null -> null; _, !null -> !null")
java.lang.Object getOrDefault(@NotNull
                                                                                    @NotNull java.lang.String key,
                                                                                    @Nullable
                                                                                    @Nullable java.lang.Object defaultValue)

getUncheckedOrThrow

@NotNull
<T> T getUncheckedOrThrow(@NotNull
                                   @NotNull java.lang.String key)

Gets a value from the storage.

Parameters:

key - the key

Returns:

the value

contains

boolean contains(@NotNull
                 @NotNull TypedKey<?> key)

Checks if the storage contains a key.

Parameters:

key - the key

Returns:

true if the storage contains a key, false otherwise

keys

@NotNull
@NotNull @UnmodifiableView java.util.Collection<TypedKey<?>> keys()

Gets the keys from the storage.

Returns:

the keys

values

@NotNull
@NotNull @UnmodifiableView java.util.Collection<java.lang.Object> values()

Gets the values from the storage.

Returns:

the values

entries

@NotNull
@NotNull @UnmodifiableView java.util.Collection<java.util.Map.Entry<TypedKey<?>,java.lang.Object>> entries()

Gets the entries from the storage.

Returns:

the entries

map

@NotNull
@NotNull @UnmodifiableView java.util.Map<TypedKey<?>,java.lang.Object> map()

Gets the map from the storage.

Returns:

the map