GeneralSettings (BoostedYAML 1.1 API)

java.lang.Object
- dev.dejvokep.boostedyaml.settings.general.GeneralSettings

```
public class GeneralSettings
extends Object
```
General settings cover all options related to documents in general.
Settings introduced by BoostedYAML follow builder design pattern, e.g. you may build your own settings using GeneralSettings.builder() //configure// .build()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GeneralSettings.Builder` Builder for general settings.
`static class`	`GeneralSettings.KeyFormat` Key format for sections to use; specifies how the loaded/supplied keys should be formatted.

Field Summary

Fields
Modifier and Type	Field and Description
`static GeneralSettings`	`DEFAULT` Default general settings.
`static Boolean`	`DEFAULT_BOOLEAN` Default boolean.
`static String`	`DEFAULT_ESCAPED_SEPARATOR` Escaped version of the default separator.
`static Character`	`DEFAULT_CHAR` Default char.
`static GeneralSettings.KeyFormat`	`DEFAULT_KEY_FORMATTING` Default key format.
`static ListSupplier`	`DEFAULT_LIST` Default list supplier.
`static MapSupplier`	`DEFAULT_MAP` Default map supplier.
`static Number`	`DEFAULT_NUMBER` Default number.
`static Object`	`DEFAULT_OBJECT` Default object.
`static char`	`DEFAULT_ROUTE_SEPARATOR` The default string route separator.
`static YamlSerializer`	`DEFAULT_SERIALIZER` Default serializer.
`static SetSupplier`	`DEFAULT_SET` Default set supplier.
`static String`	`DEFAULT_STRING` Default string.
`static boolean`	`DEFAULT_USE_DEFAULTS` If to use defaults by default.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GeneralSettings.Builder`	`builder()` Returns a new builder.
`static GeneralSettings.Builder`	`builder(GeneralSettings settings)` Returns a new builder with the same configuration as the given settings.
`Boolean`	`getDefaultBoolean()` Returns default boolean to use by `Section` getters if the return type is boolean.
`Character`	`getDefaultChar()` Returns default char to use by `Section` getters if the return type is char.
`<T> List<T>`	`getDefaultList()` Returns an empty default list.
`<T> List<T>`	`getDefaultList(int size)` Returns default list of the given size.
`<K,V> Map<K,V>`	`getDefaultMap()` Returns an empty default map.
`<K,V> Map<K,V>`	`getDefaultMap(int size)` Returns default map of the given size.
`MapSupplier`	`getDefaultMapSupplier()` Returns default map supplier to use to supply map instances during loading/creating new sections/when needed.
`Number`	`getDefaultNumber()` Returns default number to use by `Section` getters if the return type is a number - integer, float, byte, biginteger...
`Object`	`getDefaultObject()` Returns default object to use by `Section` getters if the return type is object.
`<T> Set<T>`	`getDefaultSet()` Returns an empty default set.
`<T> Set<T>`	`getDefaultSet(int size)` Returns default set of the given size.
`String`	`getDefaultString()` Returns default string to use by `Section` getters if the return type is string.
`String`	`getEscapedSeparator()` Returns the escaped route separator.
`GeneralSettings.KeyFormat`	`getKeyFormat()` Returns the key format to use.
`char`	`getRouteSeparator()` Sets route separator used to separate individual keys inside a string route and vice-versa.
`YamlSerializer`	`getSerializer()` Returns serializer to use for custom object serialization/deserialization.
`boolean`	`isUseDefaults()` Returns 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

- Field Detail
  - DEFAULT_ROUTE_SEPARATOR
```
public static final char DEFAULT_ROUTE_SEPARATOR
```
    The default string route separator.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ESCAPED_SEPARATOR
```
public static final String DEFAULT_ESCAPED_SEPARATOR
```
    Escaped version of the default separator.
  - DEFAULT_KEY_FORMATTING
```
public static final GeneralSettings.KeyFormat DEFAULT_KEY_FORMATTING
```
    Default key format.
  - DEFAULT_SERIALIZER
```
public static final YamlSerializer DEFAULT_SERIALIZER
```
    Default serializer.
  - DEFAULT_USE_DEFAULTS
```
public static final boolean DEFAULT_USE_DEFAULTS
```
    If to use defaults by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OBJECT
```
public static final Object DEFAULT_OBJECT
```
    Default object.
  - DEFAULT_NUMBER
```
public static final Number DEFAULT_NUMBER
```
    Default number.
  - DEFAULT_STRING
```
public static final String DEFAULT_STRING
```
    Default string.
  - DEFAULT_CHAR
```
public static final Character DEFAULT_CHAR
```
    Default char.
  - DEFAULT_BOOLEAN
```
public static final Boolean DEFAULT_BOOLEAN
```
    Default boolean.
  - DEFAULT_LIST
```
public static final ListSupplier DEFAULT_LIST
```
    Default list supplier.
  - DEFAULT_SET
```
public static final SetSupplier DEFAULT_SET
```
    Default set supplier.
  - DEFAULT_MAP
```
public static final MapSupplier DEFAULT_MAP
```
    Default map supplier.
  - DEFAULT
```
public static final GeneralSettings DEFAULT
```
    Default general settings.
- Method Detail
  - getKeyFormat
```
public GeneralSettings.KeyFormat getKeyFormat()
```
    Returns the key format to use.
    
    Returns:
    
    the key format to use
    
    See Also:
    
    Builder#setKeyFormat(KeyFormat)
  - getRouteSeparator
```
public char getRouteSeparator()
```
    Sets route separator used to separate individual keys inside a string route and vice-versa.
    
    Returns:
    
    separator the separator to use
  - getEscapedSeparator
```
public String getEscapedSeparator()
```
    Returns the escaped route separator.
    
    Returns:
    
    the escaped route separator
    
    See Also:
    
    getRouteSeparator()
  - getSerializer
```
public YamlSerializer getSerializer()
```
    Returns serializer to use for custom object serialization/deserialization.
    
    Returns:
    
    the serializer to use
  - isUseDefaults
```
public boolean isUseDefaults()
```
    Returns if to enable use of the defaults by Section methods (if any are present).
    
    Returns:
    
    if to use defaults
  - getDefaultObject
```
public Object getDefaultObject()
```
    Returns default object to use by Section getters if the return type is object.
    
    Returns:
    
    the default object
  - getDefaultString
```
public String getDefaultString()
```
    Returns default string to use by Section getters if the return type is string.
    
    Returns:
    
    the default string
  - getDefaultChar
```
public Character getDefaultChar()
```
    Returns default char to use by Section getters if the return type is char.
    
    Returns:
    
    the default char
  - getDefaultNumber
```
public Number getDefaultNumber()
```
    Returns default number to use by Section getters if the return type is a number - integer, float, byte, biginteger... (per the getter documentation).
    
    Returns:
    
    the default number
  - getDefaultBoolean
```
public Boolean getDefaultBoolean()
```
    Returns default boolean to use by Section getters if the return type is boolean.
    
    Returns:
    
    the default boolean
  - getDefaultList
```
public <T> List<T> getDefaultList(int size)
```
    Returns default list of the given size.
    
    Type Parameters:
    
    T - content type
    
    Parameters:
    
    size - initial size (if supported)
    
    Returns:
    
    the default list of the given size
  - getDefaultList
```
public <T> List<T> getDefaultList()
```
    Returns an empty default list.
    
    Type Parameters:
    
    T - content type
    
    Returns:
    
    the empty default list
  - getDefaultSet
```
public <T> Set<T> getDefaultSet(int size)
```
    Returns default set of the given size.
    
    Type Parameters:
    
    T - content type
    
    Parameters:
    
    size - initial size (if supported)
    
    Returns:
    
    the default set of the given size
  - getDefaultSet
```
public <T> Set<T> getDefaultSet()
```
    Returns an empty default set.
    
    Type Parameters:
    
    T - content type
    
    Returns:
    
    the empty default set
  - getDefaultMap
```
public <K,V> Map<K,V> getDefaultMap(int size)
```
    Returns default map of the given size.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    size - initial size (if supported)
    
    Returns:
    
    the default map of the given size
  - getDefaultMap
```
public <K,V> Map<K,V> getDefaultMap()
```
    Returns an empty default map.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    the empty default map
  - getDefaultMapSupplier
```
public MapSupplier getDefaultMapSupplier()
```
    Returns default map supplier to use to supply map instances during loading/creating new sections/when needed.
    
    Returns:
    
    the supplier
  - builder
```
public static GeneralSettings.Builder builder()
```
    Returns a new builder.
    
    Returns:
    
    the new builder
  - builder
```
public static GeneralSettings.Builder builder(GeneralSettings settings)
```
    Returns a new builder with the same configuration as the given settings.
    
    Parameters:
    
    settings - preset settings
    
    Returns:
    
    the new builder

Class GeneralSettings

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ROUTE_SEPARATOR

DEFAULT_ESCAPED_SEPARATOR

DEFAULT_KEY_FORMATTING

DEFAULT_SERIALIZER

DEFAULT_USE_DEFAULTS

DEFAULT_OBJECT

DEFAULT_NUMBER

DEFAULT_STRING

DEFAULT_CHAR

DEFAULT_BOOLEAN

DEFAULT_LIST

DEFAULT_SET

DEFAULT_MAP

DEFAULT

Method Detail

getKeyFormat

getRouteSeparator

getEscapedSeparator

getSerializer

isUseDefaults

getDefaultObject

getDefaultString

getDefaultChar

getDefaultNumber

getDefaultBoolean

getDefaultList

getDefaultList

getDefaultSet

getDefaultSet

getDefaultMap

getDefaultMap

getDefaultMapSupplier

builder

builder