org.anvilpowered.anvil.api.data.registry

Interface Registry

All Known Subinterfaces:

ConfigurationService

All Known Implementing Classes:

BaseConfigurationService, BaseExtendedRegistry, BaseRegistry

public interface Registry

Method Summary

Modifier and Type	Method and Description
<T> void	addToCollection(Key<? extends java.util.Collection<T>> key, T value) Adds the provided value to this registry's Collection value for the provided Key
<T> java.util.Optional<T>	get(Key<T> key) Gets this registry's value for the provided Key or Optional.empty() if it is not present.
default <T> T	getDefault(Key<T> key) Gets this registry's default value for the provided Key or the fallback value if it is not present.
default <T> T	getOrDefault(Key<T> key) Gets this registry's value for the provided Key or the default value if it is not present.
<T> T	getUnsafe(Key<T> key) Gets this registry's value for the provided Key and throws an exception if it is not present.
void	load() Runs all listeners that were added before this call.
<K,T> void	putInMap(Key<? extends java.util.Map<K,T>> key, K mapKey, T mapValue) Puts the provided key and value pair to this registry's Map value for the provided Key
<T> void	remove(Key<T> key) Removes this registry's value for the provided Key
<T> void	removeFromCollection(Key<? extends java.util.Collection<T>> key, T value) Removes the provided value from this registry's Collection value for the provided Key
<K,T> void	removeFromMap(Key<? extends java.util.Map<K,T>> key, K mapKey) Removes the provided key from this registry's Map value for the provided Key
<T> void	set(Key<T> key, T value) Sets this registry's value for the provided Key
<T> void	transform(Key<T> key, java.util.function.BiFunction<? super Key<T>,? super T,? extends T> transformer) Applies the provided transformation to this registry's value for the provided Key
<T> void	transform(Key<T> key, java.util.function.Function<? super T,? extends T> transformer) Applies the provided transformation to this registry's value for the provided Key
void	whenLoaded(java.lang.Runnable listener) Adds a Runnable to be loaded on load()

Method Detail

getUnsafe

<T> T getUnsafe(Key<T> key)

Gets this registry's value for the provided Key and throws an exception if it is not present.

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to get the value for

Returns:

This registry's value for the provided Key

Throws:

java.util.NoSuchElementException - If this registry has no value defined for the provided Key

get

<T> java.util.Optional<T> get(Key<T> key)

Gets this registry's value for the provided Key or Optional.empty() if it is not present.

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to get the value for

Returns:

This registry's value for the provided Key or Optional.empty()

getDefault

default <T> T getDefault(Key<T> key)

Gets this registry's default value for the provided Key or the fallback value if it is not present.

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to get the default value for

Returns:

This registry's default value for the provided Key or the fallback value

getOrDefault

default <T> T getOrDefault(Key<T> key)

Gets this registry's value for the provided Key or the default value if it is not present.

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to get the default value for

Returns:

This registry's value for the provided Key or the default value

set

<T> void set(Key<T> key,
             T value)

Sets this registry's value for the provided Key

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to set the value for

value - The value to set

remove

<T> void remove(Key<T> key)

Removes this registry's value for the provided Key

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to set the value for

transform

<T> void transform(Key<T> key,
                   java.util.function.BiFunction<? super Key<T>,? super T,? extends T> transformer)

Applies the provided transformation to this registry's value for the provided Key

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to transform the value for

transformer - The transformation to apply

transform

<T> void transform(Key<T> key,
                   java.util.function.Function<? super T,? extends T> transformer)

Applies the provided transformation to this registry's value for the provided Key

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to transform the value for

transformer - The transformation to apply

addToCollection

<T> void addToCollection(Key<? extends java.util.Collection<T>> key,
                         T value)

Adds the provided value to this registry's Collection value for the provided Key

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key of the collection to add the provided value to

value - The value to add

removeFromCollection

<T> void removeFromCollection(Key<? extends java.util.Collection<T>> key,
                              T value)

Removes the provided value from this registry's Collection value for the provided Key

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key of the collection to add the provided value to

value - The value to add

putInMap

<K,T> void putInMap(Key<? extends java.util.Map<K,T>> key,
                    K mapKey,
                    T mapValue)

Puts the provided key and value pair to this registry's Map value for the provided Key

Type Parameters:

K - The key type of the map value for the provided key

T - The value type of the map value for the provided key

Parameters:

key - The Key of the map to add the provided key and value pair to

mapKey - The map key to add

mapValue - The map value to add

removeFromMap

<K,T> void removeFromMap(Key<? extends java.util.Map<K,T>> key,
                         K mapKey)

Removes the provided key from this registry's Map value for the provided Key

Type Parameters:

K - The key type of the map value for the provided key

T - The value type of the map value for the provided key

Parameters:

key - The Key of the map to remove the provided mapKey from

mapKey - The map key to remove

load

void load()

Runs all listeners that were added before this call.

See Also:

Environment.reload(), whenLoaded(Runnable)

whenLoaded

void whenLoaded(java.lang.Runnable listener)

Adds a Runnable to be loaded on load()

Parameters:

listener - Listener to add

See Also:

load()