dev.dejvokep.boostedyaml.settings.updater

Class UpdaterSettings

java.lang.Object

dev.dejvokep.boostedyaml.settings.updater.UpdaterSettings

public class UpdaterSettings
extends Object

Updater settings cover all options related explicitly (only) to file updating.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdaterSettings.Builder Builder for updater settings.
static class	UpdaterSettings.OptionSorting Enum defining how options in sections should be sorted during merging.

Field Summary

Fields

Modifier and Type	Field and Description
static UpdaterSettings	DEFAULT Default updater settings.
static boolean	DEFAULT_AUTO_SAVE If to, by default, automatically save the file after updating.
static boolean	DEFAULT_ENABLE_DOWNGRADING If to enable file downgrading by default.
static boolean	DEFAULT_KEEP_ALL If to keep all non-merged content (present in the document, but not in the defaults) inside the document by default.
static Map<MergeRule,Boolean>	DEFAULT_MERGE_RULES Default merge preservation rules.
static UpdaterSettings.OptionSorting	DEFAULT_OPTION_SORTING Default option sorting.
static Versioning	DEFAULT_VERSIONING Default versioning.

Constructor Summary

Constructors

Constructor and Description
UpdaterSettings(UpdaterSettings.Builder builder) Creates final, immutable updater settings from the given builder.

Method Summary

Modifier and Type	Method and Description
static UpdaterSettings.Builder	builder() Returns a new builder.
static UpdaterSettings.Builder	builder(UpdaterSettings settings) Returns a new builder with the same configuration as the given settings.
List<Consumer<YamlDocument>>	getCustomLogic(String versionId) Returns custom logic to run at the given version ID.
Set<Route>	getIgnoredRoutes(String versionId, char separator) Returns which routes to ignore if updating to the specified version ID.
Map<Route,ValueMapper>	getMappers(String versionId, char separator) Returns mappers to apply at the given version ID.
Map<MergeRule,Boolean>	getMergeRules() Returns merge preservation rules.
UpdaterSettings.OptionSorting	getOptionSorting() Returns how to sort options in sections during merging.
Map<Route,Route>	getRelocations(String versionId, char separator) Returns relocations (in from route = to route format) that took effect at the given version ID.
Versioning	getVersioning() Returns the versioning.
boolean	isAutoSave() Sets if the file should automatically be saved using YamlDocument.save() after the updater has finished updating (does not save if nothing's changed).
boolean	isEnableDowngrading() Returns if to enable downgrading.
boolean	isKeepAll() Returns if to keep all non-merged (that don't have an equivalent in the defaults) blocks in the document.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_AUTO_SAVE

public static final boolean DEFAULT_AUTO_SAVE

If to, by default, automatically save the file after updating.

See Also:

Constant Field Values

DEFAULT_ENABLE_DOWNGRADING

public static final boolean DEFAULT_ENABLE_DOWNGRADING

If to enable file downgrading by default.

See Also:

Constant Field Values

DEFAULT_KEEP_ALL

public static final boolean DEFAULT_KEEP_ALL

If to keep all non-merged content (present in the document, but not in the defaults) inside the document by default.

See Also:

Constant Field Values

DEFAULT_OPTION_SORTING

public static final UpdaterSettings.OptionSorting DEFAULT_OPTION_SORTING

Default option sorting.

DEFAULT_MERGE_RULES

public static final Map<MergeRule,Boolean> DEFAULT_MERGE_RULES

Default merge preservation rules.

DEFAULT_VERSIONING

public static final Versioning DEFAULT_VERSIONING

Default versioning.

DEFAULT

public static final UpdaterSettings DEFAULT

Default updater settings.

Constructor Detail

UpdaterSettings

public UpdaterSettings(UpdaterSettings.Builder builder)

Creates final, immutable updater settings from the given builder.

Parameters:

builder - the builder

Method Detail

getMergeRules

public Map<MergeRule,Boolean> getMergeRules()

Returns merge preservation rules.

The given map contains the merge rule as the key, with the value representing if to preserve content already in the document instead of the equivalent from the defaults.

Returns:

the merge rules

getIgnoredRoutes

public Set<Route> getIgnoredRoutes(@NotNull
                                   String versionId,
                                   char separator)

Returns which routes to ignore if updating to the specified version ID.

Parameters:

versionId - version for which to return the routes

separator - separator used to parse the string routes

Returns:

the set of routes representing blocks to ignore at the version ID

getRelocations

public Map<Route,Route> getRelocations(@NotNull
                                       String versionId,
                                       char separator)

Returns relocations (in from route = to route format) that took effect at the given version ID.

Parameters:

versionId - the version ID for which to return relocations

separator - separator used to parse the string routes

Returns:

relocations that took effect at the version ID

getMappers

public Map<Route,ValueMapper> getMappers(@NotNull
                                         String versionId,
                                         char separator)

Returns mappers to apply at the given version ID.

Parameters:

versionId - the version ID for which to return mappers

separator - separator used to parse the string routes

Returns:

the mappers to apply at the given version ID

getCustomLogic

public List<Consumer<YamlDocument>> getCustomLogic(@NotNull
                                                   String versionId)

Returns custom logic to run at the given version ID.

Parameters:

versionId - the version ID for which to return custom logic

Returns:

the custom logic to run at the given version ID

getVersioning

public Versioning getVersioning()

Returns the versioning.

Returns:

the versioning

isEnableDowngrading

public boolean isEnableDowngrading()

Returns if to enable downgrading.

Returns:

if to enable downgrading

isKeepAll

public boolean isKeepAll()

Returns if to keep all non-merged (that don't have an equivalent in the defaults) blocks in the document.

Returns:

if to keep all non-merged blocks

isAutoSave

public boolean isAutoSave()

Sets if the file should automatically be saved using YamlDocument.save() after the updater has finished updating (does not save if nothing's changed).

Returns:

if the file should automatically be saved

getOptionSorting

public UpdaterSettings.OptionSorting getOptionSorting()

Returns how to sort options in sections during merging.

Returns:

option sorting to use

builder

public static UpdaterSettings.Builder builder()

Returns a new builder.

Returns:

the new builder

builder

public static UpdaterSettings.Builder builder(UpdaterSettings settings)

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

Parameters:

settings - preset settings

Returns:

the new builder