Package net.orbyfied.j8.config

Class ConfigurationHelper<S extends org.bukkit.configuration.ConfigurationSection>

java.lang.Object

net.orbyfied.j8.config.ConfigurationHelper<S>

public class ConfigurationHelper<S extends org.bukkit.configuration.ConfigurationSection>
extends Object

Helper class for managing configurations and configurables. Includes a lot of boilerplate.

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<S>	afterSave	Runs after saving.
protected Consumer<S>	beforeLoad	Runs before loading.
protected final HashMap<String,ConfigurationHelper<org.bukkit.configuration.ConfigurationSection>>	children	The children of this helper.
protected final List<Configurable<?>>	configurables	All configurables linearly.
protected final Map<Class<?>,Configurable<?>>	configurablesByClass	All configurables mapped by class.
protected S	section	The configuration section to load from.

Constructor Summary

Constructors

Constructor	Description
ConfigurationHelper()

Method Summary

Modifier and Type	Method	Description
ConfigurationHelper<S>	addConfigurable(Configurable<?> c)	Add a configurable.
ConfigurationHelper<S>	afterSave(Consumer<S> consumer)
ConfigurationHelper<S>	applyTemplate(Consumer<ConfigurationHelper<? extends S>> consumer)
ConfigurationHelper<S>	beforeLoad(Consumer<S> consumer)
static Consumer<ConfigurationHelper<org.bukkit.configuration.file.YamlConfiguration>>	bukkitYamlConfiguration(Path file, String defaults)
<C extends org.bukkit.configuration.ConfigurationSection> ConfigurationHelper<S>	child(String key, Supplier<ConfigurationHelper<C>> supplier)
<C extends org.bukkit.configuration.ConfigurationSection> ConfigurationHelper<S>	child(String key, Supplier<ConfigurationHelper<C>> supplier, Consumer<ConfigurationHelper<C>> consumer)
<C extends org.bukkit.configuration.ConfigurationSection> ConfigurationHelper<?>	createChildren(String s, Supplier<ConfigurationHelper<C>> supplier)
ConfigurationHelper<?>	getChild(String s)
Map<String,ConfigurationHelper<org.bukkit.configuration.ConfigurationSection>>	getChildren()	Get the children of this configuration helper.
<T extends Configurable<?>> T	getConfigurable(Class<T> klass)	Get a configurable by class.
List<Configurable<?>>	getConfigurables()	Get all configurables.
Map<Class<?>,Configurable<?>>	getConfigurablesByClass()	Get all configurables by class.
static org.bukkit.configuration.ConfigurationSection	getOrCreateSection(org.bukkit.configuration.ConfigurationSection cfg, String path)
ConfigurationHelper<S>	load()	Loads all configurables from the configuration section.
static void	loadFromFile(org.bukkit.configuration.file.FileConfiguration cfg, Path file)
ConfigurationHelper<S>	loadOne(Configurable<?> c)	Loads one configurable from the configuration section.
static ConfigurationHelper<org.bukkit.configuration.file.YamlConfiguration>	newYamlFileConfiguration(Path file, String defaults)
ConfigurationHelper<S>	removeConfigurable(Class<?> c)	Remove a configurable by class.
ConfigurationHelper<S>	removeConfigurable(Configurable<?> c)	Remove a configurable by instance.
ConfigurationHelper<S>	save()	Saves all configurables to a configuration section.
static boolean	saveDefaults(Class<?> resolver, String resource, Path to, boolean overwrite)
static void	saveToFile(org.bukkit.configuration.file.FileConfiguration cfg, Path file)
ConfigurationHelper<S>	section(S section)
String	toString()
ConfigurationHelper<S>	unchild(String key)

Methods inherited from class java.lang.Object

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

Field Details

configurables

protected final List<Configurable<?>> configurables

All configurables linearly.

configurablesByClass

protected final Map<Class<?>,Configurable<?>> configurablesByClass

All configurables mapped by class.

children

protected final HashMap<String,ConfigurationHelper<org.bukkit.configuration.ConfigurationSection>> children

The children of this helper.

section

protected S extends org.bukkit.configuration.ConfigurationSection section

The configuration section to load from.

beforeLoad

protected Consumer<S extends org.bukkit.configuration.ConfigurationSection> beforeLoad

Runs before loading.

afterSave

protected Consumer<S extends org.bukkit.configuration.ConfigurationSection> afterSave

Runs after saving.

Constructor Details

ConfigurationHelper

public ConfigurationHelper()

Method Details

getConfigurables

public List<Configurable<?>> getConfigurables()

Get all configurables.

Returns:

An unmodifiable list.

getConfigurablesByClass

public Map<Class<?>,Configurable<?>> getConfigurablesByClass()

Get all configurables by class.

Returns:

An unmodifiable map.

getChildren

public Map<String,ConfigurationHelper<org.bukkit.configuration.ConfigurationSection>> getChildren()

Get the children of this configuration helper.

Returns:

The children mapped by name.

getConfigurable

public <T extends Configurable<?>> T getConfigurable(Class<T> klass)

Get a configurable by class.

Type Parameters:

T - The configurable type.

Parameters:

klass - The class.

Returns:

The configurable.

addConfigurable

public ConfigurationHelper<S> addConfigurable(Configurable<?> c)

Add a configurable. Registers it to the list and maps it by class.

Parameters:

c - The configurable.

Returns:

This.

removeConfigurable

public ConfigurationHelper<S> removeConfigurable(Configurable<?> c)

Remove a configurable by instance.

Parameters:

c - The configurable.

Returns:

This.

removeConfigurable

public ConfigurationHelper<S> removeConfigurable(Class<?> c)

Remove a configurable by class.

Parameters:

c - The class.

Returns:

This.

section

public ConfigurationHelper<S> section(S section)

afterSave

public ConfigurationHelper<S> afterSave(Consumer<S> consumer)

beforeLoad

public ConfigurationHelper<S> beforeLoad(Consumer<S> consumer)

child

public <C extends org.bukkit.configuration.ConfigurationSection>
ConfigurationHelper<S> child(String key,
 Supplier<ConfigurationHelper<C>> supplier,
 Consumer<ConfigurationHelper<C>> consumer)

child

public <C extends org.bukkit.configuration.ConfigurationSection>
ConfigurationHelper<S> child(String key,
 Supplier<ConfigurationHelper<C>> supplier)

unchild

public ConfigurationHelper<S> unchild(String key)

save

public ConfigurationHelper<S> save()

Saves all configurables to a configuration section.

Returns:

This.

loadOne

public ConfigurationHelper<S> loadOne(Configurable<?> c)

Loads one configurable from the configuration section.

Returns:

This.

load

public ConfigurationHelper<S> load()

Loads all configurables from the configuration section.

Returns:

This.

getChild

public ConfigurationHelper<?> getChild(String s)

createChildren

public <C extends org.bukkit.configuration.ConfigurationSection>
ConfigurationHelper<?> createChildren(String s,
 Supplier<ConfigurationHelper<C>> supplier)

applyTemplate

public ConfigurationHelper<S> applyTemplate(Consumer<ConfigurationHelper<? extends S>> consumer)

toString

public String toString()

Overrides:

toString in class Object

bukkitYamlConfiguration

public static Consumer<ConfigurationHelper<org.bukkit.configuration.file.YamlConfiguration>> bukkitYamlConfiguration(Path file,
 String defaults)

getOrCreateSection

public static org.bukkit.configuration.ConfigurationSection getOrCreateSection(org.bukkit.configuration.ConfigurationSection cfg,
 String path)

saveDefaults

public static boolean saveDefaults(Class<?> resolver,
 String resource,
 Path to,
 boolean overwrite)

saveToFile

public static void saveToFile(org.bukkit.configuration.file.FileConfiguration cfg,
 Path file)

loadFromFile

public static void loadFromFile(org.bukkit.configuration.file.FileConfiguration cfg,
 Path file)

newYamlFileConfiguration

public static ConfigurationHelper<org.bukkit.configuration.file.YamlConfiguration> newYamlFileConfiguration(Path file,
 String defaults)