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 final class	YamlConfigurationLoader.Builder	Builds a YamlConfigurationLoader.

Field Summary

Fields

Modifier and Type	Field	Description
static final RepresentationHint<Integer>	BLANK_LINE_STYLE_OVERRIDE	The amount of blank lines that a specific node should have.
static final RepresentationHint<NodeStyle>	NODE_STYLE	The YAML node style to use for collection nodes.
static final RepresentationHint<ScalarStyle>	SCALAR_STYLE	The YAML scalar style this node should attempt to use.

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)
protected void	loadInternal(CommentedConfigurationNode node, BufferedReader reader)
protected void	saveInternal(ConfigurationNode node, Writer 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

Field Details

SCALAR_STYLE

public static final RepresentationHint<ScalarStyle> SCALAR_STYLE

The YAML scalar style this node should attempt to use.

If the chosen scalar style would produce syntactically invalid YAML, a valid one will replace it.

Since:

4.3.0

NODE_STYLE

public static final RepresentationHint<NodeStyle> NODE_STYLE

The YAML node style to use for collection nodes. A null value will instruct the emitter to fall back to the YamlConfigurationLoader.Builder.nodeStyle() setting.

Since:

4.3.0

BLANK_LINE_STYLE_OVERRIDE

public static final RepresentationHint<Integer> BLANK_LINE_STYLE_OVERRIDE

The amount of blank lines that a specific node should have. Absent is to inherit the BlankLineStyle of the document.

Since:

4.3.0

Method Details

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)

Specified by:

loadInternal in class AbstractConfigurationLoader<CommentedConfigurationNode>

saveInternal

protected void saveInternal(ConfigurationNode node,
 Writer writer)

Specified by:

saveInternal in class AbstractConfigurationLoader<CommentedConfigurationNode>

createNode

public CommentedConfigurationNode createNode(ConfigurationOptions options)