dev.dejvokep.boostedyaml.settings.loader

Class LoaderSettings.Builder

java.lang.Object

dev.dejvokep.boostedyaml.settings.loader.LoaderSettings.Builder

Enclosing class:

LoaderSettings

public static class LoaderSettings.Builder
extends Object

Builder for loader settings; wrapper for SnakeYAML Engine's LoadSettingsBuilder class which is more detailed, provides more options and possibilities, hides options which should not be configured.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ALLOW_DUPLICATE_KEYS If to allow duplicate keys by default.
static boolean	DEFAULT_AUTO_UPDATE If to automatically update the file after load by default.
static boolean	DEFAULT_CREATE_FILE_IF_ABSENT If to automatically create a new file if absent by default.
static boolean	DEFAULT_DETAILED_ERRORS If to print detailed error messages by default.

Method Summary

Modifier and Type	Method and Description
LoaderSettings	build() Builds the settings.
LoaderSettings.Builder	setAllowDuplicateKeys(boolean allowDuplicateKeys) Sets if to allow duplicate keys in sections (last key wins when loading).
LoaderSettings.Builder	setAutoUpdate(boolean autoUpdate) If enabled, automatically calls YamlDocument.update() after the document has been loaded.
LoaderSettings.Builder	setCreateFileIfAbsent(boolean createFileIfAbsent) Sets if to create a new file and save it if it does not exist automatically.
LoaderSettings.Builder	setDetailedErrors(boolean detailedErrors) Sets if to print detailed error messages.
LoaderSettings.Builder	setEnvironmentConfig(org.snakeyaml.engine.v2.env.EnvConfig envConfig) Sets custom environment variable config.
LoaderSettings.Builder	setErrorLabel(String label) Sets custom label for error messages.
LoaderSettings.Builder	setMaxCollectionAliases(int maxCollectionAliases) Sets maximum aliases a collection can have to prevent memory leaks (see Billion laughs attack).
LoaderSettings.Builder	setScalarResolver(org.snakeyaml.engine.v2.resolver.ScalarResolver resolver) Sets custom scalar resolver, used to resolve tags for objects.
LoaderSettings.Builder	setTagConstructors(Map<org.snakeyaml.engine.v2.nodes.Tag,org.snakeyaml.engine.v2.api.ConstructNode> constructors) Sets custom node to Java object constructors, per YAML tag.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CREATE_FILE_IF_ABSENT

public static final boolean DEFAULT_CREATE_FILE_IF_ABSENT

If to automatically create a new file if absent by default.

See Also:

Constant Field Values

DEFAULT_AUTO_UPDATE

public static final boolean DEFAULT_AUTO_UPDATE

If to automatically update the file after load by default.

See Also:

Constant Field Values

DEFAULT_DETAILED_ERRORS

public static final boolean DEFAULT_DETAILED_ERRORS

If to print detailed error messages by default.

See Also:

Constant Field Values

DEFAULT_ALLOW_DUPLICATE_KEYS

public static final boolean DEFAULT_ALLOW_DUPLICATE_KEYS

If to allow duplicate keys by default.

See Also:

Constant Field Values

Method Detail

setCreateFileIfAbsent

public LoaderSettings.Builder setCreateFileIfAbsent(boolean createFileIfAbsent)

Sets if to create a new file and save it if it does not exist automatically.

Not effective if there is no file associated with the document.

Default: DEFAULT_CREATE_FILE_IF_ABSENT

Parameters:

createFileIfAbsent - if to create a new file if absent

Returns:

the builder

setAutoUpdate

public LoaderSettings.Builder setAutoUpdate(boolean autoUpdate)

If enabled, automatically calls YamlDocument.update() after the document has been loaded.

Not effective if there are no defaults associated with the document.

Default: DEFAULT_AUTO_UPDATE

Parameters:

autoUpdate - if to automatically update after loading

Returns:

the builder

setErrorLabel

public LoaderSettings.Builder setErrorLabel(@NotNull
                                            String label)

Sets custom label for error messages.

For additional information, please refer to documentation of the parent method listed below.

Default: defined by the parent method
Parent method: LoadSettingsBuilder.setLabel(String)
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): -

Parameters:

label - the label

Returns:

the builder

setDetailedErrors

public LoaderSettings.Builder setDetailedErrors(boolean detailedErrors)

Sets if to print detailed error messages.

For additional information, please refer to documentation of the parent method listed below.

Default: DEFAULT_DETAILED_ERRORS
Parent method: LoadSettingsBuilder.setUseMarks(boolean)
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): -

Parameters:

detailedErrors - if to print detailed errors

Returns:

the builder

setAllowDuplicateKeys

public LoaderSettings.Builder setAllowDuplicateKeys(boolean allowDuplicateKeys)

Sets if to allow duplicate keys in sections (last key wins when loading).

For additional information, please refer to documentation of the parent method listed below.

Default: DEFAULT_ALLOW_DUPLICATE_KEYS
Parent method: LoadSettingsBuilder.setAllowDuplicateKeys(boolean)
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): -

Parameters:

allowDuplicateKeys - if to allow duplicate keys

Returns:

the builder

setMaxCollectionAliases

public LoaderSettings.Builder setMaxCollectionAliases(int maxCollectionAliases)

Sets maximum aliases a collection can have to prevent memory leaks (see Billion laughs attack).

For additional information, please refer to documentation of the parent method listed below.

Default: defined by the parent method
Parent method: LoadSettingsBuilder.setMaxAliasesForCollections(int)
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): -

Parameters:

maxCollectionAliases - maximum aliases for collections

Returns:

the builder

setTagConstructors

public LoaderSettings.Builder setTagConstructors(@NotNull
                                                 Map<org.snakeyaml.engine.v2.nodes.Tag,org.snakeyaml.engine.v2.api.ConstructNode> constructors)

Sets custom node to Java object constructors, per YAML tag.

For additional information, please refer to documentation of the parent method listed below.

Default: defined by the parent method
Parent method: LoadSettingsBuilder.setTagConstructors(Map) (int)}
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): JSON schema tags, failsafe schema tags

Parameters:

constructors - constructor map

Returns:

the builder

setScalarResolver

public LoaderSettings.Builder setScalarResolver(@NotNull
                                                org.snakeyaml.engine.v2.resolver.ScalarResolver resolver)

Sets custom scalar resolver, used to resolve tags for objects.

For additional information, please refer to documentation of the parent method listed below.

Default: defined by the parent method
Parent method: LoadSettingsBuilder.setScalarResolver(ScalarResolver)
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): JSON schema tags, failsafe schema tags

Parameters:

resolver - the resolver to set

Returns:

the builder

See Also:

DumpSettingsBuilder.setScalarResolver(ScalarResolver)

setEnvironmentConfig

public LoaderSettings.Builder setEnvironmentConfig(@Nullable
                                                   org.snakeyaml.engine.v2.env.EnvConfig envConfig)

Sets custom environment variable config.

For additional information, please refer to documentation of the parent method listed below.

Default: defined by the parent method
Parent method: LoadSettingsBuilder.setEnvConfig(Optional)
Parent method docs (v2.3): click
Related YAML spec (v1.2.2): -

Parameters:

envConfig - the config to set

Returns:

the builder

See Also:

DumpSettingsBuilder.setScalarResolver(ScalarResolver)

build

public LoaderSettings build()

Builds the settings.

Returns:

the settings