Package org.spongepowered.configurate.gson

Class GsonConfigurationLoader.Builder

java.lang.Object

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

org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder

Enclosing class:

GsonConfigurationLoader

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

Builds a GsonConfigurationLoader.

This builder supports the following options:

• INDENT
• LENIENT

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.option.Option<Integer>	INDENT	The level of indentation to be used by the resulting loader.
static final net.kyori.option.Option<Boolean>	LENIENT	If the resultant loader should parse leniently.
static final net.kyori.option.OptionSchema	SCHEMA	A schema of options available on the Gson loader.

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

defaultOptions, HEADER_MODE, headerMode, sink, source

Method Summary

Modifier and Type	Method	Description
@NonNull GsonConfigurationLoader	build()	Builds the loader.
int	indent()	Gets the level of indentation to be used by the resultant loader.
@NonNull GsonConfigurationLoader.Builder	indent(int indent)	Sets the level of indentation the resultant loader should use.
boolean	lenient()	Gets if the resultant loader should parse leniently.
@NonNull GsonConfigurationLoader.Builder	lenient(boolean lenient)	Sets if the resultant loader should parse leniently.
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 on the Gson loader.

Since:

4.2.0

INDENT

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

The level of indentation to be used by the resulting loader.

Since:

4.2.0

LENIENT

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

If the resultant loader should parse leniently.

Since:

4.2.0

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

Returns:

the option schema

indent

public @NonNull GsonConfigurationLoader.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

lenient

public @NonNull GsonConfigurationLoader.Builder lenient(boolean lenient)

Sets if the resultant loader should parse leniently.

Parameters:

lenient - whether the parser should parse leniently

Returns:

this builder (for chaining)

Since:

4.0.0

See Also:

• JsonReader.setLenient(boolean)

lenient

public boolean lenient()

Gets if the resultant loader should parse leniently.

Returns:

whether the parser should parse leniently

Since:

4.0.0

build

public @NonNull GsonConfigurationLoader build()

Description copied from class: AbstractConfigurationLoader.Builder

Builds the loader.

Specified by:

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

Returns:

a new loader