tech.ferus.util.config

Class ConfigFile<T extends ninja.leaping.configurate.ConfigurationNode>

java.lang.Object

tech.ferus.util.config.ConfigFile<T>

Type Parameters:

T - the type of ConfigurationNode

Direct Known Subclasses:

GsonConfigFile, HoconConfigFile, JsonConfigFile, YamlConfigFile

public class ConfigFile<T extends ninja.leaping.configurate.ConfigurationNode>
extends java.lang.Object

A wrapper for Configurate's ConfigurationLoader. Allows you to easily get and save data.

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.file.Path	file The location of the configuration file on disk.
private ninja.leaping.configurate.loader.ConfigurationLoader<T>	loader The active loader for the configuration file on disk.
private static org.slf4j.Logger	LOGGER The ConfigFile logger.
private T	root The loaded ConfigurationNode at the root level.

Constructor Summary

Constructors

Constructor and Description
ConfigFile(java.nio.file.Path file, ninja.leaping.configurate.loader.ConfigurationLoader<T> loader, T root) Constructs a new ConfigFile.

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getFile() Gets the location of the configuration file on disk.
java.nio.file.Path	getFileDirectory() Gets the location of the configuration file's parent directory on disk.
ninja.leaping.configurate.loader.ConfigurationLoader<T>	getLoader() Gets the active loader for the configuration file on disk.
T	getNode() Gets the root ConfigurationNode.
ninja.leaping.configurate.ConfigurationNode	getNode(java.lang.Object... path) Gets a ConfigurationNode on any level.
ninja.leaping.configurate.ConfigurationNode	getNode(java.lang.Object path) Gets a ConfigurationNode on the first level.
boolean	reload() Reloads the configuration from the ConfigurationLoader.
void	reloadWithException() Reloads the configuration from the ConfigurationLoader.
boolean	save() Saves the root ConfigurationNode with the active ConfigurationLoader.
void	saveWithException() Saves the root ConfigurationNode with the active ConfigurationLoader.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

The ConfigFile logger.

file

@Nonnull
private final java.nio.file.Path file

The location of the configuration file on disk.

loader

@Nonnull
private final ninja.leaping.configurate.loader.ConfigurationLoader<T extends ninja.leaping.configurate.ConfigurationNode> loader

The active loader for the configuration file on disk.

root

@Nonnull
private T extends ninja.leaping.configurate.ConfigurationNode root

The loaded ConfigurationNode at the root level.

Constructor Detail

ConfigFile

public ConfigFile(@Nonnull
                  java.nio.file.Path file,
                  @Nonnull
                  ninja.leaping.configurate.loader.ConfigurationLoader<T> loader,
                  @Nonnull
                  T root)

Constructs a new ConfigFile.

Parameters:

file - the location of the configuration file on disk

loader - the active loaded for the configuration file on disk

root - the loaded ConfigurationNode at the root level

Method Detail

getFile

@Nonnull
public java.nio.file.Path getFile()

Gets the location of the configuration file on disk.

Returns:

the location of the configuration file on disk

getFileDirectory

@Nonnull
public java.nio.file.Path getFileDirectory()

Gets the location of the configuration file's parent directory on disk.

Returns:

the location of the configuration file's parent directory on disk

getLoader

@Nonnull
public ninja.leaping.configurate.loader.ConfigurationLoader<T> getLoader()

Gets the active loader for the configuration file on disk.

Returns:

the active loader for the configuration file on disk

getNode

@Nonnull
public T getNode()

Gets the root ConfigurationNode.

Returns:

the root node

getNode

public ninja.leaping.configurate.ConfigurationNode getNode(java.lang.Object path)

Gets a ConfigurationNode on the first level.

Parameters:

path - the key for the node

Returns:

a ConfigurationNode on the first level

getNode

public ninja.leaping.configurate.ConfigurationNode getNode(java.lang.Object... path)

Gets a ConfigurationNode on any level.

Parameters:

path - the key path for the node

Returns:

a ConfigurationNode on any level

save

public boolean save()

Saves the root ConfigurationNode with the active ConfigurationLoader.

Does not give exceptions upon failure.

Returns:

true if save was successful; false otherwise

saveWithException

public void saveWithException()
                       throws java.io.IOException

Saves the root ConfigurationNode with the active ConfigurationLoader.

Throws:

java.io.IOException - if ConfigurationLoader.save(ConfigurationNode) throws an exception

reload

public boolean reload()

Reloads the configuration from the ConfigurationLoader.

Does not give exceptions upon failure.

Returns:

true if reload was successful; false otherwise

reloadWithException

public void reloadWithException()
                         throws java.io.IOException

Reloads the configuration from the ConfigurationLoader.

Throws:

java.io.IOException - if ConfigurationLoader.load() throws an exception