dev.dejvokep.boostedyaml.settings.updater

Class UpdaterSettings.Builder

java.lang.Object

dev.dejvokep.boostedyaml.settings.updater.UpdaterSettings.Builder

Enclosing class:

UpdaterSettings

public static class UpdaterSettings.Builder
extends Object

Builder for updater settings.

Method Summary

Modifier and Type	Method and Description
UpdaterSettings	build() Builds the settings.
UpdaterSettings.Builder	setAutoSave(boolean autoSave) Sets if the file should automatically be saved using YamlDocument.save() after the updater has finished updating (does not save if nothing's changed).
UpdaterSettings.Builder	setEnableDowngrading(boolean enableDowngrading) Sets if to enable downgrading.
UpdaterSettings.Builder	setIgnoredRoutes(Map<String,Set<Route>> routes) Sets which blocks (represented by their routes) to ignore (including their contents) while updating to a certain version ID.
UpdaterSettings.Builder	setIgnoredRoutes(String versionId, Set<Route> routes) Sets which blocks (represented by their routes) to ignore (including their contents) while updating to the specified version ID.
UpdaterSettings.Builder	setIgnoredStringRoutes(Map<String,Set<String>> routes) Sets which blocks (represented by their string routes) to ignore (including their contents) while updating to a certain version ID.
UpdaterSettings.Builder	setIgnoredStringRoutes(String versionId, Set<String> routes) Sets which blocks (represented by their string routes) to ignore (including their contents) while updating to a certain version ID.
UpdaterSettings.Builder	setKeepAll(boolean keepAll) Sets if to keep all non-merged (that don't have an equivalent in the defaults) blocks in the document instead of deleting them.
UpdaterSettings.Builder	setMergeRule(MergeRule rule, boolean preserveDocument) Sets merge preservation rule and overwrites the already existing value for the given rule.
UpdaterSettings.Builder	setMergeRules(Map<MergeRule,Boolean> mergeRules) Sets merge preservation rules.
UpdaterSettings.Builder	setRelocations(Map<String,Map<Route,Route>> relocations) Sets relocations (in from route = to route format) per version ID, at which they took place.
UpdaterSettings.Builder	setRelocations(String versionId, Map<Route,Route> relocations) Sets relocations (in from route = to route format) that took effect at the given version ID.
UpdaterSettings.Builder	setStringRelocations(Map<String,Map<String,String>> relocations) Sets relocations (in from route = to route format) per version ID, at which they took place.
UpdaterSettings.Builder	setStringRelocations(String versionId, Map<String,String> relocations) Sets relocations (in from route = to route format) that took effect at the given version ID.
UpdaterSettings.Builder	setVersioning(Pattern pattern, Route route) Sets versioning information.
UpdaterSettings.Builder	setVersioning(Pattern pattern, String route) Sets versioning information.
UpdaterSettings.Builder	setVersioning(Pattern pattern, String documentVersionId, String defaultsVersionId) Sets versioning information.
UpdaterSettings.Builder	setVersioning(Versioning versioning) Sets versioning information.

Methods inherited from class java.lang.Object

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

Method Detail

setAutoSave

public UpdaterSettings.Builder setAutoSave(boolean autoSave)

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

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

Default: UpdaterSettings.DEFAULT_AUTO_SAVE

Parameters:

autoSave - if to save automatically after update

Returns:

the builder

setEnableDowngrading

public UpdaterSettings.Builder setEnableDowngrading(boolean enableDowngrading)

Sets if to enable downgrading.

Downgrading is considered to be a situation:

• when there are valid version IDs found for both files (supplied manually or automatically from files),
• the version ID of the document represents newer version than version ID of the defaults.

Please note that by specification, the defaults must have a valid ID supplied/specified.

If the updater detects downgrading, and it is enabled, the updater will skip relocations, proceeding directly to merging; throws an error otherwise. If configured like so, you may also want to disable LoaderSettings.Builder#setAutoUpdate(boolean) (if an error is thrown, you won't be able to create the document).

Effective if and only a versioning is specified.

Default: UpdaterSettings.DEFAULT_ENABLE_DOWNGRADING

Parameters:

enableDowngrading - if to enable downgrading

Returns:

the builder

setKeepAll

public UpdaterSettings.Builder setKeepAll(boolean keepAll)

Sets if to keep all non-merged (that don't have an equivalent in the defaults) blocks in the document instead of deleting them.

Default: UpdaterSettings.DEFAULT_KEEP_ALL

Parameters:

keepAll - if to keep all non-merged blocks in the document

Returns:

the builder

setMergeRules

public UpdaterSettings.Builder setMergeRules(@NotNull
                                             Map<MergeRule,Boolean> mergeRules)

Sets merge preservation rules. Overwrites only rules that are defined in the given map. You can learn more at MergeRule.

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

Default: UpdaterSettings.DEFAULT_MERGE_RULES

Parameters:

mergeRules - the merge rules to set

Returns:

the builder

See Also:

setMergeRule(MergeRule, boolean)

setMergeRule

public UpdaterSettings.Builder setMergeRule(@NotNull
                                            MergeRule rule,
                                            boolean preserveDocument)

Sets merge preservation rule and overwrites the already existing value for the given rule. You can learn more at MergeRule.

Default: UpdaterSettings.DEFAULT_MERGE_RULES

Parameters:

rule - the rule to set

preserveDocument - if to preserve content already in the document instead of the equivalent from defaults for this rule

Returns:

the builder

setIgnoredRoutes

public UpdaterSettings.Builder setIgnoredRoutes(@NotNull
                                                Map<String,Set<Route>> routes)

Sets which blocks (represented by their routes) to ignore (including their contents) while updating to a certain version ID. If there already are routes defined for version ID, which is also present in the given map, they are overwritten.

This is generally useful for sections which users can freely extend. In this sense, we can say that you should specify a version ID of the document and routes of such sections (which were in the document with the ID).

Effective if and only a versioning is specified.

Parameters:

routes - routes to ignore, per version ID

Returns:

the builder

See Also:

setIgnoredRoutes(String, Set)

setIgnoredRoutes

public UpdaterSettings.Builder setIgnoredRoutes(@NotNull
                                                String versionId,
                                                @NotNull
                                                Set<Route> routes)

Sets which blocks (represented by their routes) to ignore (including their contents) while updating to the specified version ID. If there already are routes defined for the given ID, they are overwritten.

This is generally useful for sections which users can freely extend. In this sense, we can say that you should specify a version ID of the document and routes of such sections (which were in the document with the ID).

Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

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

Returns:

the builder

setIgnoredStringRoutes

public UpdaterSettings.Builder setIgnoredStringRoutes(@NotNull
                                                      Map<String,Set<String>> routes)

Sets which blocks (represented by their string routes) to ignore (including their contents) while updating to a certain version ID. If there already are string routes defined for version ID, which is also present in the given map, they are overwritten.

This is generally useful for sections which users can freely extend. In this sense, we can say that you should specify a version ID of the document and routes of such sections (which were in the document with the ID).

Effective if and only a versioning is specified.

Parameters:

routes - string routes to ignore, per version ID

Returns:

the builder

See Also:

setIgnoredStringRoutes(String, Set)

setIgnoredStringRoutes

public UpdaterSettings.Builder setIgnoredStringRoutes(@NotNull
                                                      String versionId,
                                                      @NotNull
                                                      Set<String> routes)

Sets which blocks (represented by their string routes) to ignore (including their contents) while updating to a certain version ID. If there already are string routes defined for the given ID, they are overwritten.

This is generally useful for sections which users can freely extend. In this sense, we can say that you should specify a version ID of the document and routes of such sections (which were in the document with the ID).

Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

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

Returns:

the builder

setRelocations

public UpdaterSettings.Builder setRelocations(@NotNull
                                              Map<String,Map<Route,Route>> relocations)

Sets relocations (in from route = to route format) per version ID, at which they took place. If there already are relocations defined for version ID which is also present in the given map, they are overwritten.

Relocations define that some setting was moved from route x to y, enabling the updater to reproduce those steps without any content loss. The ID at which a relocation took effect is equal to ID of the file which included the changes.

Effective if and only a versioning is specified.

Parameters:

relocations - the relocations, per version ID

Returns:

the builder

See Also:

setRelocations(String, Map)

setRelocations

public UpdaterSettings.Builder setRelocations(@NotNull
                                              String versionId,
                                              @NotNull
                                              Map<Route,Route> relocations)

Sets relocations (in from route = to route format) that took effect at the given version ID. If there already are relocations defined for the version ID, they are overwritten.

Relocations define that some setting was moved from route x to y, enabling the updater to reproduce those steps without any content loss.The ID at which a relocation took effect is equal to ID of the file which included the changes.

Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

relocations - relocations that took effect at the version ID

Returns:

the builder

setStringRelocations

public UpdaterSettings.Builder setStringRelocations(@NotNull
                                                    Map<String,Map<String,String>> relocations)

Sets relocations (in from route = to route format) per version ID, at which they took place. If there already are relocations defined for version ID which is also present in the given map, they are overwritten.

Relocations define that some setting was moved from route x to y, enabling the updater to reproduce those steps without any content loss.The ID at which a relocation took effect is equal to ID of the file which included the changes.

Please note that all relocations will be merged when updating, with Route-based relocations having higher priority.

Effective if and only a versioning is specified.

Parameters:

relocations - the relocations, per version ID

Returns:

the builder

See Also:

setStringRelocations(String, Map)

setStringRelocations

public UpdaterSettings.Builder setStringRelocations(@NotNull
                                                    String versionId,
                                                    @NotNull
                                                    Map<String,String> relocations)

Sets relocations (in from route = to route format) that took effect at the given version ID. If there already are relocations defined for the version ID, they are overwritten.

Relocations define that some setting was moved from route x to y, enabling the updater to reproduce those steps without any content loss.The ID at which a relocation took effect is equal to ID of the file which included the changes.

Please note that all relocations will be merged when updating, with Route-based relocations having higher priority.

Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

relocations - relocations that took effect at the version ID

Returns:

the builder

setVersioning

public UpdaterSettings.Builder setVersioning(@NotNull
                                             Versioning versioning)

Sets versioning information.

If the version ID of the defaults supplied by the versioning is null, it is considered illegal and will throw a NullPointerException. If such value is returned for the document itself, the updater will assign Versioning.getFirstVersion() to it. Please see the implementation documentation.

Parameters:

versioning - the versioning

Returns:

the builder

See Also:

setVersioning(Pattern, String, String), setVersioning(Pattern, Route)

setVersioning

public UpdaterSettings.Builder setVersioning(@NotNull
                                             Pattern pattern,
                                             @Nullable
                                             String documentVersionId,
                                             @NotNull
                                             String defaultsVersionId)

Sets versioning information. Please see ManualVersioning(Pattern, String, String).

Parameters:

pattern - the pattern

documentVersionId - version ID of the document that's being updated

defaultsVersionId - version ID of the defaults

Returns:

the builder

See Also:

setVersioning(Versioning)

setVersioning

public UpdaterSettings.Builder setVersioning(@NotNull
                                             Pattern pattern,
                                             @NotNull
                                             Route route)

Sets versioning information. Please see AutomaticVersioning(Pattern, Route).

Parameters:

pattern - the pattern

route - the route to version IDs (of both files)

Returns:

the builder

setVersioning

public UpdaterSettings.Builder setVersioning(@NotNull
                                             Pattern pattern,
                                             @NotNull
                                             String route)

Sets versioning information. Please see AutomaticVersioning(Pattern, String).

Parameters:

pattern - the pattern

route - the route to version IDs (of both files)

Returns:

the builder

build

public UpdaterSettings build()

Builds the settings.

Returns:

the settings