tech.ferus.util.config

Class YamlConfigFile

java.lang.Object

tech.ferus.util.config.ConfigFile<ninja.leaping.configurate.ConfigurationNode>

tech.ferus.util.config.YamlConfigFile

public class YamlConfigFile
extends ConfigFile<ninja.leaping.configurate.ConfigurationNode>

An implementation of ConfigFile for the YAML specification.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static YamlConfigFile	load(java.nio.file.Path file) Creates a YamlConfigFile.
static YamlConfigFile	load(java.nio.file.Path file, java.lang.String resource) Creates a YamlConfigFile.
static YamlConfigFile	load(java.nio.file.Path file, java.lang.String resource, boolean overwrite) Creates a YamlConfigFile.
static YamlConfigFile	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, getNode, 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 YamlConfigFile logger.

Constructor Detail

YamlConfigFile

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

Constructs a new YamlConfigFile.

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

load

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

Creates a YamlConfigFile.

Parameters:

file - the location of the config file on disk

Returns:

a new YamlConfigFile

Throws:

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

load

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

Creates a YamlConfigFile.

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 YamlConfigFile

Throws:

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

load

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

Creates a YamlConfigFile.

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 YamlConfigFile

Throws:

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

load

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

Deprecated.

Creates a YamlConfigFile.

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 YamlConfigFile

Throws:

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