dev.dejvokep.boostedyaml.settings.general

Class GeneralSettings.Builder

java.lang.Object

dev.dejvokep.boostedyaml.settings.general.GeneralSettings.Builder

Enclosing class:

GeneralSettings

public static class GeneralSettings.Builder
extends Object

Builder for general settings.

Method Summary

Modifier and Type	Method and Description
GeneralSettings	build() Builds the settings.
GeneralSettings.Builder	setDefaultBoolean(Boolean defaultBoolean) Sets default boolean used by section getters if the return type is boolean.
GeneralSettings.Builder	setDefaultChar(Character defaultChar) Sets default char used by section getters if the return type is char.
GeneralSettings.Builder	setDefaultList(ListSupplier defaultList) Sets default list supplier used to supply list instances during loading/when needed.
GeneralSettings.Builder	setDefaultMap(MapSupplier defaultMap) Sets default map supplier used to supply map instances during loading/creating new sections/when needed.
GeneralSettings.Builder	setDefaultNumber(Number defaultNumber) Sets default number used by section getters if the return type is a number - integer, float, byte, biginteger...
GeneralSettings.Builder	setDefaultObject(Object defaultObject) Sets default object used by section getters if the return type is object.
GeneralSettings.Builder	setDefaultSet(SetSupplier defaultSet) Sets default set supplier used to supply set instances during loading/when needed.
GeneralSettings.Builder	setDefaultString(String defaultString) Sets default string used by section getters if the return type is string.
GeneralSettings.Builder	setKeyFormat(GeneralSettings.KeyFormat keyFormat) Sets the key format to use.
GeneralSettings.Builder	setRouteSeparator(char separator) Sets route separator used to separate individual keys inside a string route and vice-versa.
GeneralSettings.Builder	setSerializer(YamlSerializer serializer) Sets serializer used for custom object serialization/deserialization.
GeneralSettings.Builder	setUseDefaults(boolean useDefaults) Sets if to enable use of the defaults by Section methods (if any are present).

Methods inherited from class java.lang.Object

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

Method Detail

setKeyFormat

public GeneralSettings.Builder setKeyFormat(@NotNull
                                            GeneralSettings.KeyFormat keyFormat)

Sets the key format to use.

Default: GeneralSettings.DEFAULT_KEY_FORMATTING

Parameters:

keyFormat - the key format to use

Returns:

the builder

See Also:

setRouteSeparator(char)

setRouteSeparator

public GeneralSettings.Builder setRouteSeparator(char separator)

Sets route separator used to separate individual keys inside a string route and vice-versa.

Default: GeneralSettings.DEFAULT_ROUTE_SEPARATOR

Parameters:

separator - the separator to use

Returns:

the builder

setSerializer

public GeneralSettings.Builder setSerializer(@NotNull
                                             YamlSerializer serializer)

Sets serializer used for custom object serialization/deserialization.

Default: GeneralSettings.DEFAULT_SERIALIZER

Parameters:

serializer - the serializer to use

Returns:

the builder

setUseDefaults

public GeneralSettings.Builder setUseDefaults(boolean useDefaults)

Sets if to enable use of the defaults by Section methods (if any are present).

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

If enabled (true):

• Bulk getter methods (which return a set/map of all keys, routes, values, blocks) will not only include content from the file, but also from the equivalent section in the defaults.
• Value getters with signature getX(route) will search the defaults as documented. You can also view the behaviour in the call stack below:
  1. Is there any value at the specified route?
     • 1A. Yes: Is it compatible with the return type (see method documentation)?
       • 2A. Yes: Return it.
       • 2B. No: Is there an equivalent of this section in the defaults (Section.hasDefaults())?
         • 3A. Yes: Return the value returned by calling the same method on the default section equivalent (Section.getDefaults()).
         • 3B. No: Return the default value defined by the settings (see method documentation).
     • 1B. No: Continue with 2B.

If disabled (false):

• None of the Section methods will interact with the defaults.
• This is recommended if you would like to handle all value absences (present in the defaults, but not in the file) and invalid values manually - e.g. notifying the user and then using the default value defined within final fields, or obtained via Section.getDefaults().

Default: GeneralSettings.DEFAULT_USE_DEFAULTS

Parameters:

useDefaults - if to use defaults

Returns:

the builder

setDefaultObject

public GeneralSettings.Builder setDefaultObject(@Nullable
                                                Object defaultObject)

Sets default object used by section getters if the return type is object.

Default: GeneralSettings.DEFAULT_OBJECT

Parameters:

defaultObject - default object

Returns:

the builder

setDefaultNumber

public GeneralSettings.Builder setDefaultNumber(@NotNull
                                                Number defaultNumber)

Sets default number used by section getters if the return type is a number - integer, float, byte, biginteger... (per the getter documentation).

Default: GeneralSettings.DEFAULT_NUMBER

The given default can not be null as multiple section getters derive their defaults from this default (using Number.intValue()...).

Parameters:

defaultNumber - default number

Returns:

the builder

setDefaultString

public GeneralSettings.Builder setDefaultString(@Nullable
                                                String defaultString)

Sets default string used by section getters if the return type is string.

Default: GeneralSettings.DEFAULT_STRING

Parameters:

defaultString - default string

Returns:

the builder

setDefaultChar

public GeneralSettings.Builder setDefaultChar(@Nullable
                                              Character defaultChar)

Sets default char used by section getters if the return type is char.

Default: GeneralSettings.DEFAULT_CHAR

The parameter is not of a primitive type, to allow for null values. Setting the default to such value might produce unexpected issues, unless your program is adapted for it. On the other hand, there are methods returning optionals, so having default value like this is rather pointless.

Parameters:

defaultChar - default char

Returns:

the builder

setDefaultBoolean

public GeneralSettings.Builder setDefaultBoolean(@Nullable
                                                 Boolean defaultBoolean)

Sets default boolean used by section getters if the return type is boolean.

Default: GeneralSettings.DEFAULT_BOOLEAN

The parameter is not of a primitive type, to allow for null values. Setting the default to such value might produce unexpected issues, unless your program is adapted for it. On the other hand, there are methods returning optionals, so having default value like this is rather pointless.

Parameters:

defaultBoolean - default boolean

Returns:

the builder

setDefaultList

public GeneralSettings.Builder setDefaultList(@NotNull
                                              ListSupplier defaultList)

Sets default list supplier used to supply list instances during loading/when needed.

Default: GeneralSettings.DEFAULT_LIST

Parameters:

defaultList - the supplier

Returns:

the builder

setDefaultSet

public GeneralSettings.Builder setDefaultSet(@NotNull
                                             SetSupplier defaultSet)

Sets default set supplier used to supply set instances during loading/when needed.

Default: GeneralSettings.DEFAULT_SET

Parameters:

defaultSet - the supplier

Returns:

the builder

setDefaultMap

public GeneralSettings.Builder setDefaultMap(@NotNull
                                             MapSupplier defaultMap)

Sets default map supplier used to supply map instances during loading/creating new sections/when needed.

Default: GeneralSettings.DEFAULT_MAP

Parameters:

defaultMap - the supplier

Returns:

the builder

build

public GeneralSettings build()

Builds the settings.

Returns:

the settings