dev.dejvokep.boostedyaml.settings.loader

Class LoaderSettings

java.lang.Object

dev.dejvokep.boostedyaml.settings.loader.LoaderSettings

public class LoaderSettings
extends Object

Loader settings cover all options related explicitly (only) to file loading.

Settings introduced by BoostedYAML follow builder design pattern, e.g. you may build your own settings using LoaderSettings.builder() //configure// .build()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoaderSettings.Builder 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 LoaderSettings	DEFAULT Default loader settings.

Method Summary

Modifier and Type	Method and Description
org.snakeyaml.engine.v2.api.LoadSettings	buildEngineSettings(GeneralSettings generalSettings) Builds the SnakeYAML Engine settings.
static LoaderSettings.Builder	builder() Returns a new builder.
static LoaderSettings.Builder	builder(LoaderSettings settings) Returns a new builder with the same configuration as the given settings.
static LoaderSettings.Builder	builder(org.snakeyaml.engine.v2.api.LoadSettingsBuilder builder) Creates and returns a new builder from the given, already created SnakeYAML Engine settings builder.
boolean	isAutoUpdate() Returns if to automatically call YamlDocument.update() after the document has been loaded.
boolean	isCreateFileIfAbsent() Returns if to create a new file and save it if it does not exist automatically.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final LoaderSettings DEFAULT

Default loader settings.

Method Detail

isAutoUpdate

public boolean isAutoUpdate()

Returns if to automatically call YamlDocument.update() after the document has been loaded.

Returns:

if to automatically update after the document has been loaded

isCreateFileIfAbsent

public boolean isCreateFileIfAbsent()

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

Returns:

if to create a new file if absent

buildEngineSettings

public org.snakeyaml.engine.v2.api.LoadSettings buildEngineSettings(GeneralSettings generalSettings)

Builds the SnakeYAML Engine settings.

Parameters:

generalSettings - settings used to get defaults (list, set, map) from

Returns:

the new settings

builder

public static LoaderSettings.Builder builder()

Returns a new builder.

Returns:

the new builder

builder

public static LoaderSettings.Builder builder(org.snakeyaml.engine.v2.api.LoadSettingsBuilder builder)

Creates and returns a new builder from the given, already created SnakeYAML Engine settings builder.

Note that the given builder is not cloned, so it is in the caller's best interest to never change it's settings from now on.

Please note that LoaderSettings.Builder.setCreateFileIfAbsent(boolean) and LoaderSettings.Builder.setAutoUpdate(boolean) still have to be called (if you want to alter the default), as they are not part of the Engine's settings.

Parameters:

builder - the underlying builder

Returns:

the new builder

builder

public static LoaderSettings.Builder builder(LoaderSettings settings)

Returns a new builder with the same configuration as the given settings.

Parameters:

settings - preset settings

Returns:

the new builder