Package org.spongepowered.configurate.hocon

Class HoconConfigurationLoader.Builder

java.lang.Object

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

org.spongepowered.configurate.hocon.HoconConfigurationLoader.Builder

Enclosing class:

HoconConfigurationLoader

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

Builds a HoconConfigurationLoader.

This builder supports the following options:

• AbstractConfigurationLoader.Builder.HEADER_MODE
• PRETTY_PRINTING
• INDENT
• COMMENTS
• JSON_COMPATIBLE

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.option.Option<Boolean>	COMMENTS	Set whether comments will be emitted.
static final net.kyori.option.Option<Integer>	INDENT	Set the amount of spaces to indent with when prettyPrinting(boolean) is on.
static final net.kyori.option.Option<Boolean>	JSON_COMPATIBLE	Set whether JSON compatible output mode will be used.
static final net.kyori.option.Option<Boolean>	PRETTY_PRINTING	Set whether output from this loader will be pretty-printed or not.
static final net.kyori.option.OptionSchema	SCHEMA	A schema of options available to configure the Hocon loader.

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

defaultOptions, HEADER_MODE, headerMode, sink, source

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HoconConfigurationLoader	build()	Builds the loader.
HoconConfigurationLoader.Builder	emitComments(boolean emitComments)	Set whether comments should be emitted.
HoconConfigurationLoader.Builder	emitJsonCompatible(boolean jsonCompatible)	Set whether output generated by this loader should be json-compatible.
HoconConfigurationLoader.Builder	indent(int indent)	Set the amount of spaces to indent with when prettyPrinting(boolean) is on.
protected net.kyori.option.OptionSchema	optionSchema()	Get the schema of available options that can be set on this loader.
HoconConfigurationLoader.Builder	prettyPrinting(boolean prettyPrinting)	Set whether output from this loader will be pretty-printed or not.

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 Hocon loader.

Since:

4.2.0

PRETTY_PRINTING

public static final net.kyori.option.Option<Boolean> PRETTY_PRINTING

Set whether output from this loader will be pretty-printed or not.

Since:

4.2.0

See Also:

• prettyPrinting(boolean)

INDENT

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

Set the amount of spaces to indent with when prettyPrinting(boolean) is on.

Since:

4.2.0

See Also:

• indent(int)

COMMENTS

public static final net.kyori.option.Option<Boolean> COMMENTS

Set whether comments will be emitted.

Since:

4.2.0

See Also:

• emitComments(boolean)

JSON_COMPATIBLE

public static final net.kyori.option.Option<Boolean> JSON_COMPATIBLE

Set whether JSON compatible output mode will be used.

Since:

4.2.0

See Also:

• emitJsonCompatible(boolean)

Constructor Details

Builder

public Builder()

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<HoconConfigurationLoader.Builder,HoconConfigurationLoader>

Returns:

the option schema

prettyPrinting

public HoconConfigurationLoader.Builder prettyPrinting(boolean prettyPrinting)

Set whether output from this loader will be pretty-printed or not.

Parameters:

prettyPrinting - whether to pretty-print

Returns:

this builder

Since:

4.0.0

indent

public HoconConfigurationLoader.Builder indent(int indent)

Set the amount of spaces to indent with when prettyPrinting(boolean) is on.

Defaults to 4.

Parameters:

indent - indent level

Returns:

this builder

Since:

4.2.0

emitComments

public HoconConfigurationLoader.Builder emitComments(boolean emitComments)

Set whether comments should be emitted.

Comments will always be loaded from files and stored in memory.

Parameters:

emitComments - whether to emit comments

Returns:

this builder

Since:

4.0.0

emitJsonCompatible

public HoconConfigurationLoader.Builder emitJsonCompatible(boolean jsonCompatible)

Set whether output generated by this loader should be json-compatible.

Whatever format input is received in, this will output JSON. To be fully spec-compliant, comment output must also be disabled.

Parameters:

jsonCompatible - to emit json-format output

Returns:

this builder

Since:

4.0.0

build

public HoconConfigurationLoader build()

Description copied from class: AbstractConfigurationLoader.Builder

Builds the loader.

Specified by:

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

Returns:

a new loader