Package org.spongepowered.configurate.jackson

Class JacksonConfigurationLoader.Builder

java.lang.Object

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

org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder

Enclosing class:

JacksonConfigurationLoader

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

Builds a JacksonConfigurationLoader.

This builder supports the following options:

• INDENT
• FIELD_VALUE_SEPARATOR

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.option.Option<FieldValueSeparatorStyle>	FIELD_VALUE_SEPARATOR	Set the field-value separator style to be used when emitting json.
static final net.kyori.option.Option<Integer>	INDENT	Set the indentation to when emitting json.
static final net.kyori.option.OptionSchema	SCHEMA	A schema of options available to configure the Jackson loader.

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

defaultOptions, HEADER_MODE, headerMode, sink, source

Method Summary

Modifier and Type	Method	Description
JacksonConfigurationLoader	build()	Builds the loader.
JsonFactoryBuilder	factoryBuilder()	Gets the JsonFactory used to configure the implementation.
FieldValueSeparatorStyle	fieldValueSeparatorStyle()	Gets the field value separator style to be used by the built loader.
JacksonConfigurationLoader.Builder	fieldValueSeparatorStyle(FieldValueSeparatorStyle style)	Sets the field value separator style the resultant loader should use.
int	indent()	Gets the level of indentation to be used by the resultant loader.
JacksonConfigurationLoader.Builder	indent(int indent)	Sets the level of indentation the resultant 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 Jackson loader.

Since:

4.2.0

INDENT

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

Set the indentation to when emitting json.

Since:

4.2.0

See Also:

• indent(int)

FIELD_VALUE_SEPARATOR

public static final net.kyori.option.Option<FieldValueSeparatorStyle> FIELD_VALUE_SEPARATOR

Set the field-value separator style to be used when emitting json.

Since:

4.2.0

See Also:

• fieldValueSeparatorStyle(FieldValueSeparatorStyle)

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

Returns:

the option schema

factoryBuilder

public JsonFactoryBuilder factoryBuilder()

Gets the JsonFactory used to configure the implementation.

Returns:

the json factory

Since:

4.0.0

indent

public JacksonConfigurationLoader.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

fieldValueSeparatorStyle

public JacksonConfigurationLoader.Builder fieldValueSeparatorStyle(FieldValueSeparatorStyle style)

Sets the field value separator style the resultant loader should use.

Parameters:

style - the style

Returns:

this builder (for chaining)

Since:

4.0.0

fieldValueSeparatorStyle

public FieldValueSeparatorStyle fieldValueSeparatorStyle()

Gets the field value separator style to be used by the built loader.

Returns:

the style

Since:

4.0.0

build

public JacksonConfigurationLoader build()

Description copied from class: AbstractConfigurationLoader.Builder

Builds the loader.

Specified by:

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

Returns:

a new loader