tech.ferus.util.config

Class HoconConfigFile

java.lang.Object

tech.ferus.util.config.ConfigFile<ninja.leaping.configurate.commented.CommentedConfigurationNode>

tech.ferus.util.config.HoconConfigFile

public class HoconConfigFile
extends ConfigFile<ninja.leaping.configurate.commented.CommentedConfigurationNode>

An implementation of ConfigFile for the HOCON specification.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER The HoconConfigFile logger.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ninja.leaping.configurate.commented.CommentedConfigurationNode	getNode(java.lang.Object... path) Gets a ConfigurationNode on any level.
ninja.leaping.configurate.commented.CommentedConfigurationNode	getNode(java.lang.Object path) Gets a ConfigurationNode on the first level.
static HoconConfigFile	load(java.nio.file.Path file) Creates a HoconConfigFile.
static HoconConfigFile	load(java.nio.file.Path file, java.lang.String resource) Creates a HoconConfigFile.
static HoconConfigFile	load(java.nio.file.Path file, java.lang.String resource, boolean overwrite) Creates a HoconConfigFile.
static HoconConfigFile	load(java.nio.file.Path file, java.lang.String resource, boolean overwrite, boolean merge) Deprecated.

Methods inherited from class tech.ferus.util.config.ConfigFile

getFile, getFileDirectory, getLoader, getNode, reload, reloadWithException, save, saveWithException

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 HoconConfigFile logger.

Constructor Detail

HoconConfigFile

public HoconConfigFile(@Nonnull
                       java.nio.file.Path file,
                       @Nonnull
                       ninja.leaping.configurate.loader.ConfigurationLoader<ninja.leaping.configurate.commented.CommentedConfigurationNode> loader,
                       @Nonnull
                       ninja.leaping.configurate.commented.CommentedConfigurationNode root)

Constructs a new HoconConfigFile.

Additionally, passes a CommentedConfigurationNode for the loader and the root node.

Parameters:

file - the location of the configuration file on disk

loader - the active loaded for the configuration file on disk

root - the loaded CommentedConfigurationNode at the root level

Method Detail

getNode

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

Gets a ConfigurationNode on the first level.

Overrides ConfigFile.getNode(Object) to return commented nodes.

Overrides:

getNode in class ConfigFile<ninja.leaping.configurate.commented.CommentedConfigurationNode>

Parameters:

path - the key for the node

Returns:

a ConfigurationNode on the first level

getNode

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

Gets a ConfigurationNode on any level.

Overrides ConfigFile.getNode(Object...) to return commented nodes.

Overrides:

getNode in class ConfigFile<ninja.leaping.configurate.commented.CommentedConfigurationNode>

Parameters:

path - the key path for the node

Returns:

a ConfigurationNode on any level

load

public static HoconConfigFile load(java.nio.file.Path file)
                            throws java.io.IOException

Creates a HoconConfigFile.

Parameters:

file - the location of the config file on disk

Returns:

a new HoconConfigFile

Throws:

java.io.IOException - if files cannot be properly deleted/created

load

public static HoconConfigFile load(@Nonnull
                                   java.nio.file.Path file,
                                   @Nullable
                                   java.lang.String resource)
                            throws java.io.IOException

Creates a HoconConfigFile.

Also merges a configuration file from classpath into the file on disk.

Parameters:

file - the location of the config file on disk

resource - the location of the resource in the classpath

Returns:

a new HoconConfigFile

Throws:

java.io.IOException - if files cannot be properly deleted/created

load

public static HoconConfigFile load(@Nonnull
                                   java.nio.file.Path file,
                                   @Nullable
                                   java.lang.String resource,
                                   boolean overwrite)
                            throws java.io.IOException

Creates a HoconConfigFile.

Also merges a configuration file from the classpath into the file on disk.

May delete file on disk before copying resource.

Parameters:

file - the location of the config file on disk

resource - the location of the resource in the classpath

overwrite - whether or not to delete the file on disk before copying resource

Returns:

a new HoconConfigFile

Throws:

java.io.IOException - if files cannot be properly deleted/created

load

@Deprecated
public static HoconConfigFile load(@Nonnull
                                               java.nio.file.Path file,
                                               @Nullable
                                               java.lang.String resource,
                                               boolean overwrite,
                                               boolean merge)
                                        throws java.io.IOException

Deprecated.

Creates a HoconConfigFile.

May merge a configuration file from the classpath into the file on disk.

May delete the file on disk before copying resource.

If accessing this method directly, keep in mind that passing true for overwrite but false for merge is going to result in a non-existent file on disk.

Parameters:

file - the location of the config file on disk

resource - the location of the resource in the classpath

overwrite - whether or not to delete the file on disk before copying the resource

merge - whether or not to merge the resource into the file on disk

Returns:

a new HoconConfigFile

Throws:

java.io.IOException - if files cannot be properly deleted/created