org.anvilpowered.anvil.base.data.config

Class BaseConfigurationService

java.lang.Object

org.anvilpowered.anvil.base.data.registry.BaseRegistry

org.anvilpowered.anvil.base.data.config.BaseConfigurationService

All Implemented Interfaces:

ConfigurationService, Registry

public class BaseConfigurationService
extends BaseRegistry
implements ConfigurationService

Service to load and save data from a config file

Field Summary

Fields

Modifier and Type	Field and Description
protected ninja.leaping.configurate.loader.ConfigurationLoader<ninja.leaping.configurate.commented.CommentedConfigurationNode>	configLoader

Constructor Summary

Constructors

Constructor and Description
BaseConfigurationService(ninja.leaping.configurate.loader.ConfigurationLoader<ninja.leaping.configurate.commented.CommentedConfigurationNode> configLoader)

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
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
boolean	save() Updates the config with values from the registry.
<T> void	set(Key<T> key, T value) Sets this registry's value for the provided Key
protected void	setDescription(Key<?> key, java.lang.String description)
protected void	setName(Key<?> key, java.lang.String name)
protected <T> void	setVerification(Key<T> key, java.util.Map<java.util.function.Predicate<T>,java.util.function.Function<T,T>> verification)
<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
protected void	withAll()
protected void	withCore()
protected void	withDataStore()
protected void	withDataStoreCore()
protected void	withDefault()
protected void	withMongoDB()
protected void	withProxyMode()
protected void	withRedis()

Methods inherited from class org.anvilpowered.anvil.base.data.registry.BaseRegistry

get, getDefault, getUnsafe, setDefault, toString, whenLoaded

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anvilpowered.anvil.api.data.registry.Registry

get, getDefault, getOrDefault, getUnsafe, whenLoaded

Field Detail

configLoader

protected ninja.leaping.configurate.loader.ConfigurationLoader<ninja.leaping.configurate.commented.CommentedConfigurationNode> configLoader

Constructor Detail

BaseConfigurationService

@Inject
public BaseConfigurationService(ninja.leaping.configurate.loader.ConfigurationLoader<ninja.leaping.configurate.commented.CommentedConfigurationNode> configLoader)

Method Detail

withCore

protected void withCore()

withDataStoreCore

protected void withDataStoreCore()

withDataStore

protected void withDataStore()

withMongoDB

protected void withMongoDB()

withRedis

protected void withRedis()

withProxyMode

protected void withProxyMode()

withDefault

protected void withDefault()

withAll

protected void withAll()

setVerification

protected <T> void setVerification(Key<T> key,
                                   java.util.Map<java.util.function.Predicate<T>,java.util.function.Function<T,T>> verification)

setName

protected void setName(Key<?> key,
                       java.lang.String name)

setDescription

protected void setDescription(Key<?> key,
                              java.lang.String description)

set

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

Description copied from interface: Registry

Sets this registry's value for the provided Key

Specified by:

set in interface Registry

Overrides:

set in class BaseRegistry

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

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

Description copied from interface: Registry

Removes this registry's value for the provided Key

Specified by:

remove in interface Registry

Overrides:

remove in class BaseRegistry

Type Parameters:

T - The value type of the provided Key

Parameters:

key - The Key to set the value for

transform

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

Description copied from interface: Registry

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

Specified by:

transform in interface Registry

Overrides:

transform in class BaseRegistry

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

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

Description copied from interface: Registry

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

Specified by:

transform in interface Registry

Overrides:

transform in class BaseRegistry

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

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

Description copied from interface: Registry

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

Specified by:

addToCollection in interface Registry

Overrides:

addToCollection in class BaseRegistry

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

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

Description copied from interface: Registry

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

Specified by:

removeFromCollection in interface Registry

Overrides:

removeFromCollection in class BaseRegistry

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

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

Description copied from interface: Registry

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

Specified by:

putInMap in interface Registry

Overrides:

putInMap in class BaseRegistry

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

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

Description copied from interface: Registry

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

Specified by:

removeFromMap in interface Registry

Overrides:

removeFromMap in class BaseRegistry

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

public void load()

Description copied from interface: Registry

Runs all listeners that were added before this call.

Specified by:

load in interface Registry

Overrides:

load in class BaseRegistry

See Also:

Environment.reload(), Registry.whenLoaded(Runnable)

save

public boolean save()

Description copied from interface: ConfigurationService

Updates the config with values from the registry. Will only update the file if changes were made

Specified by:

save in interface ConfigurationService

Returns:

true if there were updated values to save and they were saved successfully otherwise false