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.Builder	addCustomLogic(Map<String,List<Consumer<YamlDocument>>> consumers) Adds custom logic to run on the document, per version ID.
UpdaterSettings.Builder	addCustomLogic(String versionId, Collection<Consumer<YamlDocument>> consumers) Adds custom logic to run on the document at the provided version ID.
UpdaterSettings.Builder	addCustomLogic(String versionId, Consumer<YamlDocument> consumer) Adds custom logic to run on the document at the provided version ID.
UpdaterSettings.Builder	addIgnoredRoute(String versionId, Route route) Adds a route to ignore if updating to the provided version ID.
UpdaterSettings.Builder	addIgnoredRoute(String versionId, String route, char separator) Adds a route to ignore if updating to the provided version ID.
UpdaterSettings.Builder	addIgnoredRoutes(Map<String,Set<Route>> routes) Adds routes to ignore if updating to a certain version ID.
UpdaterSettings.Builder	addIgnoredRoutes(Map<String,Set<String>> routes, char separator) Adds routes to ignore if updating to a certain version ID.
UpdaterSettings.Builder	addIgnoredRoutes(String versionId, Set<Route> routes) Adds routes to ignore if updating to the provided version ID.
UpdaterSettings.Builder	addIgnoredRoutes(String versionId, Set<String> routes, char separator) Adds routes to ignore if updating to the provided version ID.
UpdaterSettings.Builder	addMapper(String versionId, Route route, ValueMapper mapper) Adds a mapper to apply to the given route at the provided version ID.
UpdaterSettings.Builder	addMapper(String versionId, String route, ValueMapper mapper, char separator) Adds a mapper to apply to the given route at the provided version ID.
UpdaterSettings.Builder	addMappers(Map<String,Map<Route,ValueMapper>> mappers) Adds mappers to apply to their respective routes, per version ID.
UpdaterSettings.Builder	addMappers(Map<String,Map<String,ValueMapper>> mappers, char separator) Adds mappers to apply to their respective routes, per version ID.
UpdaterSettings.Builder	addMappers(String versionId, Map<Route,ValueMapper> mappers) Adds mappers to apply to their respective routes at the provided version ID.
UpdaterSettings.Builder	addMappers(String versionId, Map<String,ValueMapper> mappers, char separator) Adds mappers to apply to their respective routes at the provided version ID.
UpdaterSettings.Builder	addRelocation(String versionId, Route fromRoute, Route toRoute) Adds a relocation that took effect at the provided version ID.
UpdaterSettings.Builder	addRelocation(String versionId, String fromRoute, String toRoute, char separator) Adds a relocation that took effect at the provided version ID.
UpdaterSettings.Builder	addRelocations(Map<String,Map<Route,Route>> relocations) Adds relocations (in from route = to route format) per version ID, at which they took effect.
UpdaterSettings.Builder	addRelocations(Map<String,Map<String,String>> relocations, char separator) Adds relocations (in from route = to route format) per version ID, at which they took effect.
UpdaterSettings.Builder	addRelocations(String versionId, Map<Route,Route> relocations) Adds relocations (in from route = to route format) that took effect at the provided version ID.
UpdaterSettings.Builder	addRelocations(String versionId, Map<String,String> relocations, char separator) Adds relocations (in from route = to route format) that took effect at the provided version ID.
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) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
UpdaterSettings.Builder	setIgnoredRoutes(String versionId, Set<Route> routes) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
UpdaterSettings.Builder	setIgnoredStringRoutes(Map<String,Set<String>> routes) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
UpdaterSettings.Builder	setIgnoredStringRoutes(String versionId, Set<String> routes) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
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	setOptionSorting(UpdaterSettings.OptionSorting optionSorting) Sets how to sort options in sections during merging.
UpdaterSettings.Builder	setRelocations(Map<String,Map<Route,Route>> relocations) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
UpdaterSettings.Builder	setRelocations(String versionId, Map<Route,Route> relocations) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
UpdaterSettings.Builder	setStringRelocations(Map<String,Map<String,String>> relocations) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
UpdaterSettings.Builder	setStringRelocations(String versionId, Map<String,String> relocations) Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.
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

setOptionSorting

public UpdaterSettings.Builder setOptionSorting(@NotNull
                                                UpdaterSettings.OptionSorting optionSorting)

Sets how to sort options in sections during merging.

Default: UpdaterSettings.DEFAULT_OPTION_SORTING

Parameters:

optionSorting - option sorting to use

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

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

setIgnoredRoutes

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

setIgnoredStringRoutes

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

setIgnoredStringRoutes

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

addIgnoredRoute

public UpdaterSettings.Builder addIgnoredRoute(@NotNull
                                               String versionId,
                                               @NotNull
                                               Route route)

Adds a route to ignore if updating to the provided version ID. Ignored routes and their corresponding blocks and contents will be excluded from merging and will appear in the updated document (no matter the merge rules).

Ignoring routes is generally useful for sections which users can freely extend and their content is not strictly defined. Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

route - the route to ignore

Returns:

the builder

addIgnoredRoutes

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

Adds routes to ignore if updating to the provided version ID. Ignored routes and their corresponding blocks and contents will be excluded from merging and will appear in the updated document (no matter the merge rules).

Ignoring routes is generally useful for sections which users can freely extend and their content is not strictly defined. Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

routes - the routes to ignore

Returns:

the builder

addIgnoredRoutes

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

Adds routes to ignore if updating to a certain version ID. Ignored routes and their corresponding blocks and contents will be excluded from merging and will appear in the updated document (no matter the merge rules).

Ignoring routes is generally useful for sections which users can freely extend and their content is not strictly defined. Effective if and only a versioning is specified.

Parameters:

routes - the routes to ignore, per version ID

Returns:

the builder

addIgnoredRoute

public UpdaterSettings.Builder addIgnoredRoute(@NotNull
                                               String versionId,
                                               @NotNull
                                               String route,
                                               char separator)

Adds a route to ignore if updating to the provided version ID. Ignored routes and their corresponding blocks and contents will be excluded from merging and will appear in the updated document (no matter the merge rules).

Ignoring routes is generally useful for sections which users can freely extend and their content is not strictly defined. Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

route - the route to ignore

separator - separator used to parse the route

Returns:

the builder

addIgnoredRoutes

public UpdaterSettings.Builder addIgnoredRoutes(@NotNull
                                                String versionId,
                                                @NotNull
                                                Set<String> routes,
                                                char separator)

Adds routes to ignore if updating to the provided version ID. Ignored routes and their corresponding blocks and contents will be excluded from merging and will appear in the updated document (no matter the merge rules).

Ignoring routes is generally useful for sections which users can freely extend and their content is not strictly defined. Effective if and only a versioning is specified.

Parameters:

versionId - the version ID

routes - the routes to ignore

separator - separator used to parse the routes

Returns:

the builder

addIgnoredRoutes

public UpdaterSettings.Builder addIgnoredRoutes(@NotNull
                                                Map<String,Set<String>> routes,
                                                char separator)

Adds routes to ignore if updating to a certain version ID. Ignored routes and their corresponding blocks and contents will be excluded from merging and will appear in the updated document (no matter the merge rules).

Ignoring routes is generally useful for sections which users can freely extend and their content is not strictly defined. Effective if and only a versioning is specified.

Parameters:

routes - the routes to ignore, per version ID

separator - separator used to parse the routes

Returns:

the builder

setRelocations

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

setRelocations

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

setStringRelocations

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

setStringRelocations

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

Deprecated. Method with confusing name, use addX() instead of setX(). Subject for removal.

addRelocation

public UpdaterSettings.Builder addRelocation(@NotNull
                                             String versionId,
                                             @NotNull
                                             Route fromRoute,
                                             @NotNull
                                             Route toRoute)

Adds a relocation that took effect at the provided version ID.

Relocations represent that some mapping was moved from route x to y, which implies no content loss while updating. The ID at which a relocation took effect is the ID of the document which included the changes. If there is already a relocation defined for the version ID which is from the provided route, it is overwritten.

Relocations are useful if you moved something in the document to another place. Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

fromRoute - route from which a mapping was relocated

toRoute - route to which the mapping was relocated

Returns:

the builder

addRelocations

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

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

Relocations represent that some mapping was moved from route x to y, which implies no content loss while updating. The ID at which a relocation took effect is the ID of the document which included the changes. If there is already a relocation defined for the version ID and for a from route contained within the given map, it is overwritten.

Relocations are useful if you moved something in the document to another place. Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

relocations - relocations which took effect at the version ID

Returns:

the builder

addRelocations

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

Adds relocations (in from route = to route format) per version ID, at which they took effect.

Relocations represent that some mapping was moved from route x to y, which implies no content loss while updating. The ID at which a relocation took effect is the ID of the document which included the changes. If there is already a relocation defined for a version ID and from route contained within the given map, it is overwritten.

Relocations are useful if you moved something in the document to another place. Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

relocations - the relocations, per version ID

Returns:

the builder

addRelocation

public UpdaterSettings.Builder addRelocation(@NotNull
                                             String versionId,
                                             @NotNull
                                             String fromRoute,
                                             @NotNull
                                             String toRoute,
                                             char separator)

Adds a relocation that took effect at the provided version ID.

Relocations represent that some mapping was moved from route x to y, which implies no content loss while updating. The ID at which a relocation took effect is the ID of the document which included the changes. If there is already a relocation defined for the version ID which is from the provided route, it is overwritten.

Relocations are useful if you moved something in the document to another place. Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

fromRoute - route from which a mapping was relocated

toRoute - route to which the mapping was relocated

separator - separator used to parse the routes

Returns:

the builder

addRelocations

public UpdaterSettings.Builder addRelocations(@NotNull
                                              String versionId,
                                              @NotNull
                                              Map<String,String> relocations,
                                              char separator)

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

Relocations represent that some mapping was moved from route x to y, which implies no content loss while updating. The ID at which a relocation took effect is the ID of the document which included the changes. If there is already a relocation defined for the version ID and for a from route contained within the given map, it is overwritten.

Relocations are useful if you moved something in the document to another place. Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

relocations - relocations which took effect at the version ID

separator - separator used to parse the routes

Returns:

the builder

addRelocations

public UpdaterSettings.Builder addRelocations(@NotNull
                                              Map<String,Map<String,String>> relocations,
                                              char separator)

Adds relocations (in from route = to route format) per version ID, at which they took effect.

Relocations represent that some mapping was moved from route x to y, which implies no content loss while updating. The ID at which a relocation took effect is the ID of the document which included the changes. If there is already a relocation defined for a version ID and from route contained within the given map, it is overwritten.

Relocations are useful if you moved something in the document to another place. Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

relocations - the relocations, per version ID

separator - separator used to parse the routes

Returns:

the builder

addMapper

public UpdaterSettings.Builder addMapper(@NotNull
                                         String versionId,
                                         @NotNull
                                         Route route,
                                         @NotNull
                                         ValueMapper mapper)

Adds a mapper to apply to the given route at the provided version ID.

Mappers can be used to map (= transform) a value at a route, to different value or from one type to another (for example from a boolean to an enum). The ID at which to apply a mapper is the ID of the document which included the datatype change. If there is already a mapper defined for the version ID and the provided route, it is overwritten.

Mappers are useful if you decided to change a value to represent the same, but using another datatype (for example, you now have a multi-constant enum for which was previously only true/false setting). Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

route - route to apply the mapper at

mapper - mapper to apply at the version ID

Returns:

the builder

addMappers

public UpdaterSettings.Builder addMappers(@NotNull
                                          String versionId,
                                          @NotNull
                                          Map<Route,ValueMapper> mappers)

Adds mappers to apply to their respective routes at the provided version ID.

Mappers can be used to map (= transform) a value at a route, to different value or from one type to another (for example from a boolean to an enum). The ID at which to apply a mapper is the ID of the document which included the datatype change. If there is already a mapper defined for the version ID and for a route contained within the given map, it is overwritten.

Mappers are useful if you decided to change a value to represent the same, but using another datatype (for example, you now have a multi-constant enum for which was previously only true/false setting). Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

mappers - mappers to apply at the version ID

Returns:

the builder

addMappers

public UpdaterSettings.Builder addMappers(@NotNull
                                          Map<String,Map<Route,ValueMapper>> mappers)

Adds mappers to apply to their respective routes, per version ID.

Mappers can be used to map (= transform) a value at a route, to different value or from one type to another (for example from a boolean to an enum). The ID at which to apply a mapper is the ID of the document which included the datatype change. If there is already a mapper defined for a version ID and route contained within the given map, it is overwritten.

Mappers are useful if you decided to change a value to represent the same, but using another datatype (for example, you now have a multi-constant enum for which was previously only true/false setting). Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

mappers - the mappers, per version ID

Returns:

the builder

addMapper

public UpdaterSettings.Builder addMapper(@NotNull
                                         String versionId,
                                         @NotNull
                                         String route,
                                         @NotNull
                                         ValueMapper mapper,
                                         char separator)

Adds a mapper to apply to the given route at the provided version ID.

Mappers can be used to map (= transform) a value at a route, to different value or from one type to another (for example from a boolean to an enum). The ID at which to apply a mapper is the ID of the document which included the datatype change. If there is already a mapper defined for the version ID and the provided route, it is overwritten.

Mappers are useful if you decided to change a value to represent the same, but using another datatype (for example, you now have a multi-constant enum for which was previously only true/false setting). Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

route - route to apply the mapper at

mapper - mapper to apply at the version ID

separator - separator used to parse the routes

Returns:

the builder

addMappers

public UpdaterSettings.Builder addMappers(@NotNull
                                          String versionId,
                                          @NotNull
                                          Map<String,ValueMapper> mappers,
                                          char separator)

Adds mappers to apply to their respective routes at the provided version ID.

Mappers can be used to map (= transform) a value at a route, to different value or from one type to another (for example from a boolean to an enum). The ID at which to apply a mapper is the ID of the document which included the datatype change. If there is already a mapper defined for the version ID and for a route contained within the given map, it is overwritten.

Mappers are useful if you decided to change a value to represent the same, but using another datatype (for example, you now have a multi-constant enum for which was previously only true/false setting). Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

mappers - mappers to apply at the version ID

separator - separator used to parse the routes

Returns:

the builder

addMappers

public UpdaterSettings.Builder addMappers(@NotNull
                                          Map<String,Map<String,ValueMapper>> mappers,
                                          char separator)

Adds mappers to apply to their respective routes, per version ID.

Mappers can be used to map (= transform) a value at a route, to different value or from one type to another (for example from a boolean to an enum). The ID at which to apply a mapper is the ID of the document which included the datatype change. If there is already a mapper defined for a version ID and route contained within the given map, it is overwritten.

Mappers are useful if you decided to change a value to represent the same, but using another datatype (for example, you now have a multi-constant enum for which was previously only true/false setting). Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

mappers - the mappers, per version ID

separator - separator used to parse the routes

Returns:

the builder

addCustomLogic

public UpdaterSettings.Builder addCustomLogic(@NotNull
                                              String versionId,
                                              @NotNull
                                              Consumer<YamlDocument> consumer)

Adds custom logic to run on the document at the provided version ID.

You can use your own logic to make changes to the document which are not available via the ignored routes, relocations or mappers. The order in which the consumers are run is undefined and may vary.

Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

consumer - consumer to run

Returns:

the builder

addCustomLogic

public UpdaterSettings.Builder addCustomLogic(@NotNull
                                              Map<String,List<Consumer<YamlDocument>>> consumers)

Adds custom logic to run on the document, per version ID.

You can use your own logic to make changes to the document which are not available via the ignored routes, relocations or mappers. The order in which the consumers are run is undefined and may vary.

Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

consumers - consumers to run, per version ID

Returns:

the builder

addCustomLogic

public UpdaterSettings.Builder addCustomLogic(@NotNull
                                              String versionId,
                                              @NotNull
                                              Collection<Consumer<YamlDocument>> consumers)

Adds custom logic to run on the document at the provided version ID.

You can use your own logic to make changes to the document which are not available via the ignored routes, relocations or mappers. The order in which the consumers are run is undefined and may vary.

Effective if and only a versioning is specified.

Updating cycle for each version ID in the corresponding range (first to last): relocations -> mappers -> custom logic.

Parameters:

versionId - the version ID

consumers - consumers to run 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