Package org.spongepowered.configurate.yaml

Class YamlConfigurationLoader.Builder

java.lang.Object

org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder<YamlConfigurationLoader.Builder,YamlConfigurationLoader>

org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder

Enclosing class:

YamlConfigurationLoader

public static final class YamlConfigurationLoader.Builder
extends AbstractConfigurationLoader.Builder<YamlConfigurationLoader.Builder,YamlConfigurationLoader>

Builds a YamlConfigurationLoader.

This builder supports the following options:

<prefix>.yaml.node-style

Equivalent to nodeStyle(NodeStyle)

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.option.Option<Integer>	INDENT	The indent size (in spaces) to use for documents emitted by the created loader.
static final net.kyori.option.Option<NodeStyle>	NODE_STYLE	The collection node style to use globally when emitting with this loader.
static final net.kyori.option.OptionSchema	SCHEMA	A schema of options available to configure the YAML loader.

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

defaultOptions, HEADER_MODE, headerMode, sink, source

Method Summary

Modifier and Type	Method	Description
YamlConfigurationLoader	build()	Builds the loader.
int	indent()	Gets the level of indentation to be used by the resultant loader.
YamlConfigurationLoader.Builder	indent(int indent)	Sets the level of indentation the resultant loader should use.
@Nullable NodeStyle	nodeStyle()	Gets the node style to be used by the resultant loader.
YamlConfigurationLoader.Builder	nodeStyle(@Nullable NodeStyle style)	Sets the node style the built loader should use.
protected net.kyori.option.OptionSchema	optionSchema()	Get the schema of available options that can be set on this loader.

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

buildAndLoadString, buildAndSaveString, defaultOptions, defaultOptions, defaultOptions, editOptions, file, headerMode, headerMode, optionState, optionState, optionStateBuilder, path, sink, sink, source, source, url

Methods inherited from class java.lang.Object

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

Field Details

SCHEMA

public static final net.kyori.option.OptionSchema SCHEMA

A schema of options available to configure the YAML loader.

Since:

4.2.0

NODE_STYLE

public static final net.kyori.option.Option<NodeStyle> NODE_STYLE

The collection node style to use globally when emitting with this loader.

Since:

4.2.0

See Also:

• nodeStyle(NodeStyle)

INDENT

public static final net.kyori.option.Option<Integer> INDENT

The indent size (in spaces) to use for documents emitted by the created loader.

Since:

4.2.0

See Also:

• indent(int)

Method Details

optionSchema

protected net.kyori.option.OptionSchema optionSchema()

Description copied from class: AbstractConfigurationLoader.Builder

Get the schema of available options that can be set on this loader.

This schema should inherit from AbstractConfigurationLoader.Builder.UNSAFE_SCHEMA.

Overrides:

optionSchema in class AbstractConfigurationLoader.Builder<YamlConfigurationLoader.Builder,YamlConfigurationLoader>

Returns:

the option schema

indent

public YamlConfigurationLoader.Builder indent(int indent)

Sets the level of indentation the resultant loader should use.

Parameters:

indent - the indent level

Returns:

this builder (for chaining)

Since:

4.0.0

indent

public int indent()

Gets the level of indentation to be used by the resultant loader.

Returns:

the indent level

Since:

4.0.0

nodeStyle

public YamlConfigurationLoader.Builder nodeStyle(@Nullable NodeStyle style)

Sets the node style the built loader should use.

Flow

the compact, json-like representation.
Example: {value: [list, of, elements], another: value}

Block

expanded, traditional YAML
Example: value: - list - of - elements another: value

A null value will tell the loader to pick a value automatically based on the contents of each non-scalar node.

Parameters:

style - the node style to use

Returns:

this builder (for chaining)

Since:

4.0.0

nodeStyle

public @Nullable NodeStyle nodeStyle()

Gets the node style to be used by the resultant loader.

Returns:

the node style

Since:

4.0.0

build

public YamlConfigurationLoader build()

Description copied from class: AbstractConfigurationLoader.Builder

Builds the loader.

Specified by:

build in class AbstractConfigurationLoader.Builder<YamlConfigurationLoader.Builder,YamlConfigurationLoader>

Returns:

a new loader