Package org.spongepowered.configurate.yaml

Class YamlConfigurationLoader

java.lang.Object

org.spongepowered.configurate.loader.AbstractConfigurationLoader<CommentedConfigurationNode>

org.spongepowered.configurate.yaml.YamlConfigurationLoader

All Implemented Interfaces:

ConfigurationNodeFactory<CommentedConfigurationNode>, ConfigurationLoader<CommentedConfigurationNode>

public final class YamlConfigurationLoader
extends AbstractConfigurationLoader<CommentedConfigurationNode>

A loader for YAML-formatted configurations, using the SnakeYAML library for parsing and generation.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlConfigurationLoader.Builder	Builds a YamlConfigurationLoader.

Field Summary

Fields inherited from class org.spongepowered.configurate.loader.AbstractConfigurationLoader

CONFIGURATE_LINE_PATTERN, CONFIGURATE_LINE_SEPARATOR, sink, source, SYSTEM_LINE_SEPARATOR

Method Summary

Modifier and Type	Method	Description
static YamlConfigurationLoader.Builder	builder()	Creates a new YamlConfigurationLoader builder.
CommentedConfigurationNode	createNode(ConfigurationOptions options)	Create an empty node with the provided options.
protected void	loadInternal(CommentedConfigurationNode node, BufferedReader reader)	Using a created node, attempt to read a configuration file.
protected void	saveInternal(ConfigurationNode node, Writer writer)	Perform a save of the node to the provided writer.

Methods inherited from class org.spongepowered.configurate.loader.AbstractConfigurationLoader

canLoad, canSave, checkCanWrite, defaultCommentHandler, defaultOptions, load, loadToReference, save, writeHeaderInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.configurate.loader.ConfigurationLoader

load

Methods inherited from interface org.spongepowered.configurate.ConfigurationNodeFactory

createNode, createNode, createNode, toListCollector, toListCollector, toMapCollector, toMapCollector

Method Detail

builder

public static YamlConfigurationLoader.Builder builder()

Creates a new YamlConfigurationLoader builder.

Returns:

a new builder

Since:

4.0.0

loadInternal

protected void loadInternal(CommentedConfigurationNode node,
                            BufferedReader reader)

Description copied from class: AbstractConfigurationLoader

Using a created node, attempt to read a configuration file.

The header will already have been read if applicable.

Specified by:

loadInternal in class AbstractConfigurationLoader<CommentedConfigurationNode>

Parameters:

node - node to load into

reader - reader to load from

saveInternal

protected void saveInternal(ConfigurationNode node,
                            Writer writer)

Description copied from class: AbstractConfigurationLoader

Perform a save of the node to the provided writer.

Specified by:

saveInternal in class AbstractConfigurationLoader<CommentedConfigurationNode>

Parameters:

node - node to save

writer - writer to output to

createNode

public CommentedConfigurationNode createNode(ConfigurationOptions options)

Description copied from interface: ConfigurationNodeFactory

Create an empty node with the provided options.

Node options may be overridden if the factory enforces specific requirements on options.

Parameters:

options - node options

Returns:

newly created empty node