DumperSettings.Builder (BoostedYAML 1.1 API)

java.lang.Object
- dev.dejvokep.boostedyaml.settings.dumper.DumperSettings.Builder

Enclosing class:

DumperSettings
```
public static class DumperSettings.Builder
extends Object
```
Builder for dumper settings; wrapper for SnakeYAML Engine's DumpSettingsBuilder class which is more detailed, provides more options and possibilities, hides options which should not be configured.

Field Summary

Fields
Modifier and Type	Field and Description
`static Supplier<org.snakeyaml.engine.v2.serializer.AnchorGenerator>`	`DEFAULT_ANCHOR_GENERATOR` Default anchor generator supplier.
`static boolean`	`DEFAULT_CANONICAL` If to dump in canonical form by default.
`static DumperSettings.Encoding`	`DEFAULT_ENCODING` Default encoding.
`static boolean`	`DEFAULT_END_MARKER` If to add document end by default.
`static boolean`	`DEFAULT_ESCAPE_UNPRINTABLE` If to escape unprintable unicode characters by default.
`static org.snakeyaml.engine.v2.common.FlowStyle`	`DEFAULT_FLOW_STYLE` Default flow style.
`static int`	`DEFAULT_INDENTATION` Default spaces per one indentation level.
`static int`	`DEFAULT_INDICATOR_INDENTATION` Default spaces to use to indent indicators.
`static int`	`DEFAULT_MAX_LINE_WIDTH` Max line width by default.
`static int`	`DEFAULT_MAX_SIMPLE_KEY_LENGTH` Max length for a key to have to be dumped in simple format.
`static boolean`	`DEFAULT_MULTILINE_FORMAT` If to use multiline format by default.
`static org.snakeyaml.engine.v2.nodes.Tag`	`DEFAULT_ROOT_TAG` Default root tag.
`static org.snakeyaml.engine.v2.common.ScalarStyle`	`DEFAULT_SCALAR_STYLE` Default scalar style.
`static boolean`	`DEFAULT_START_MARKER` If to add document start by default.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DumperSettings`	`build()` Builds the settings.
`DumperSettings.Builder`	`setAnchorGenerator(Supplier<org.snakeyaml.engine.v2.serializer.AnchorGenerator> generator)` Sets custom anchor generator supplier used to supply generators when dumping.
`DumperSettings.Builder`	`setCanonicalForm(boolean canonical)` Sets if to dump in canonical form.
`DumperSettings.Builder`	`setEncoding(DumperSettings.Encoding encoding)` Sets the encoding to use.
`DumperSettings.Builder`	`setEndMarker(boolean endMarker)` Sets if to forcefully add document end marker (`...`
`DumperSettings.Builder`	`setEscapeUnprintable(boolean escape)` Sets if strings containing unprintable characters should have those characters escaped, or the whole string dumped as binary data.
`DumperSettings.Builder`	`setFlowStyle(org.snakeyaml.engine.v2.common.FlowStyle flowStyle)` Sets flow style to use.
`DumperSettings.Builder`	`setIndentation(int spaces)` Sets how many spaces to use per one indent = one level in YAML indentation hierarchy.
`DumperSettings.Builder`	`setIndicatorIndentation(int spaces)` Sets how many spaces to use per one indentation level for indicators.
`DumperSettings.Builder`	`setLineBreak(String lineBreak)` Sets the line break appended at the end of each line.
`DumperSettings.Builder`	`setLineWidth(int width)` Sets the preferred line width.
`DumperSettings.Builder`	`setMaxSimpleKeyLength(int length)` Sets the maximum length a key can (in serialized form, also applies to flow sequence and map keys) have to be printed in simple format (without the explicit key indicator `?`
`DumperSettings.Builder`	`setMultilineStyle(boolean multilineStyle)` Sets if to separate content of the document using newlines to make the dumped file somewhat readable; has effect if and only if the flow style is set to `FlowStyle.FLOW`.
`DumperSettings.Builder`	`setRootTag(org.snakeyaml.engine.v2.nodes.Tag rootTag)` Sets (explicit) tag of the root document element (top-level element in the document).
`DumperSettings.Builder`	`setScalarResolver(org.snakeyaml.engine.v2.resolver.ScalarResolver resolver)` Sets custom scalar resolver, used to resolve tags for objects.
`DumperSettings.Builder`	`setScalarStyle(org.snakeyaml.engine.v2.common.ScalarStyle scalarStyle)` Sets scalar style to use.
`DumperSettings.Builder`	`setStartMarker(boolean startMarker)` Sets if to forcefully add document start marker (`---`).
`DumperSettings.Builder`	`setTagDirectives(Map<String,String> directives)` Sets the given tag (`%TAG`) directives in form of a map, where key is the !
`DumperSettings.Builder`	`setUnprintableStyle(org.snakeyaml.engine.v2.common.NonPrintableStyle style)` Sets if strings containing unprintable characters should have those characters escaped, or the whole string dumped as binary data.
`DumperSettings.Builder`	`setYamlDirective(org.snakeyaml.engine.v2.common.SpecVersion directive)` Sets the version (`%YAML`) directive.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ANCHOR_GENERATOR
```
public static final Supplier<org.snakeyaml.engine.v2.serializer.AnchorGenerator> DEFAULT_ANCHOR_GENERATOR
```
    Default anchor generator supplier.
  - DEFAULT_FLOW_STYLE
```
public static final org.snakeyaml.engine.v2.common.FlowStyle DEFAULT_FLOW_STYLE
```
    Default flow style.
  - DEFAULT_SCALAR_STYLE
```
public static final org.snakeyaml.engine.v2.common.ScalarStyle DEFAULT_SCALAR_STYLE
```
    Default scalar style.
  - DEFAULT_START_MARKER
```
public static final boolean DEFAULT_START_MARKER
```
    If to add document start by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_END_MARKER
```
public static final boolean DEFAULT_END_MARKER
```
    If to add document end by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ROOT_TAG
```
public static final org.snakeyaml.engine.v2.nodes.Tag DEFAULT_ROOT_TAG
```
    Default root tag.
  - DEFAULT_CANONICAL
```
public static final boolean DEFAULT_CANONICAL
```
    If to dump in canonical form by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTILINE_FORMAT
```
public static final boolean DEFAULT_MULTILINE_FORMAT
```
    If to use multiline format by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENCODING
```
public static final DumperSettings.Encoding DEFAULT_ENCODING
```
    Default encoding.
  - DEFAULT_INDENTATION
```
public static final int DEFAULT_INDENTATION
```
    Default spaces per one indentation level.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INDICATOR_INDENTATION
```
public static final int DEFAULT_INDICATOR_INDENTATION
```
    Default spaces to use to indent indicators.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_LINE_WIDTH
```
public static final int DEFAULT_MAX_LINE_WIDTH
```
    Max line width by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_SIMPLE_KEY_LENGTH
```
public static final int DEFAULT_MAX_SIMPLE_KEY_LENGTH
```
    Max length for a key to have to be dumped in simple format.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ESCAPE_UNPRINTABLE
```
public static final boolean DEFAULT_ESCAPE_UNPRINTABLE
```
    If to escape unprintable unicode characters by default.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setAnchorGenerator
```
public DumperSettings.Builder setAnchorGenerator(@NotNull
                                                 Supplier<org.snakeyaml.engine.v2.serializer.AnchorGenerator> generator)
```
    Sets custom anchor generator supplier used to supply generators when dumping. Anchor generators are used to generate anchor IDs for duplicate nodes.
    Supplier ensures that a brand new, yet unused generator, is used on every file dump.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_ANCHOR_GENERATOR
    Parent method: DumpSettingsBuilder.setAnchorGenerator(AnchorGenerator)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): anchors and aliases
    
    Parameters:
    
    generator - the new anchor generator supplier
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setAnchorGenerator(AnchorGenerator)
  - setFlowStyle
```
public DumperSettings.Builder setFlowStyle(@NotNull
                                           org.snakeyaml.engine.v2.common.FlowStyle flowStyle)
```
    Sets flow style to use. Flow styles determine style of the dumped document.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_FLOW_STYLE
    Parent method: DumpSettingsBuilder.setDefaultFlowStyle(FlowStyle)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): node styles
    
    Parameters:
    
    flowStyle - the flow style to use
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setDefaultFlowStyle(FlowStyle)
  - setScalarStyle
```
public DumperSettings.Builder setScalarStyle(@NotNull
                                             org.snakeyaml.engine.v2.common.ScalarStyle scalarStyle)
```
    Sets scalar style to use.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_SCALAR_STYLE
    Parent method: DumpSettingsBuilder.setDefaultScalarStyle(ScalarStyle)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): for BLOCK flow style, for FLOW flow style
    
    Parameters:
    
    scalarStyle - the scalar style to use
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setDefaultScalarStyle(ScalarStyle)
  - setStartMarker
```
public DumperSettings.Builder setStartMarker(boolean startMarker)
```
    Sets if to forcefully add document start marker (---). If there are any directives to be dumped, it is added automatically.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_START_MARKER
    Parent method: DumpSettingsBuilder.setExplicitStart(boolean)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): document markers
    
    Parameters:
    
    startMarker - if to forcefully add document start marker
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setExplicitStart(boolean)
  - setEndMarker
```
public DumperSettings.Builder setEndMarker(boolean endMarker)
```
    Sets if to forcefully add document end marker (...).
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_END_MARKER
    Parent method: DumpSettingsBuilder.setExplicitEnd(boolean)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): document markers
    
    Parameters:
    
    endMarker - if to forcefully add document end marker
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setExplicitEnd(boolean)
  - setScalarResolver
```
public DumperSettings.Builder setScalarResolver(@NotNull
                                                org.snakeyaml.engine.v2.resolver.ScalarResolver resolver)
```
    Sets custom scalar resolver, used to resolve tags for objects.
    For additional information please refer to documentation of the parent method listed below.
    Default: defined by the parent method
    Parent method: DumpSettingsBuilder.setScalarResolver(ScalarResolver)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): JSON schema tags, failsafe schema tags
    
    Parameters:
    
    resolver - the resolver to set
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setScalarResolver(ScalarResolver)
  - setRootTag
```
public DumperSettings.Builder setRootTag(@Nullable
                                         org.snakeyaml.engine.v2.nodes.Tag rootTag)
```
    Sets (explicit) tag of the root document element (top-level element in the document).
    As this library does not support anything other than Map (represented by section) as the top-level object, the given tag must be referring to a class implementing Map interface, serious issues will occur otherwise (the given tag is not validated).
    If null, does not dump any tag for the root section (which will make the resolver resolve it automatically when the document's loaded next time).
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_ROOT_TAG
    Parent method: DumpSettingsBuilder.setExplicitRootTag(Optional)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): JSON schema tags, failsafe schema tags
    
    Parameters:
    
    rootTag - the root section tag (type)
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setExplicitRootTag(Optional)
  - setYamlDirective
```
public DumperSettings.Builder setYamlDirective(@Nullable
                                               org.snakeyaml.engine.v2.common.SpecVersion directive)
```
    Sets the version (%YAML) directive. If null, does not dump any explicit version directive.
    SnakeYAML Engine supports YAML v1.2 only, however, per the Engine specification, most of the older YAML can be processed. Always refer to the Engine's documentation for more information. To avoid problems, update to 1.2 for full support, please.
    For additional information please refer to documentation of the parent method listed below.
    Default: defined by the parent method
    Parent method: DumpSettingsBuilder.setYamlDirective(Optional)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): YAML directives
    
    Parameters:
    
    directive - the version directive
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setYamlDirective(Optional)
  - setTagDirectives
```
public DumperSettings.Builder setTagDirectives(@NotNull
                                               Map<String,String> directives)
```
    Sets the given tag (%TAG) directives in form of a map, where key is the !handle! (including the exclamation marks) and value the prefix (per the YAML spec).
    If there were any tag directives set previously, they are all overwritten.
    For additional information please refer to documentation of the parent method listed below.
    Default: defined by the parent method
    Parent method: DumpSettingsBuilder.setTagDirective(Map)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): TAG directives
    
    Parameters:
    
    directives - the tag directives
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setTagDirective(Map)
  - setCanonicalForm
```
public DumperSettings.Builder setCanonicalForm(boolean canonical)
```
    Sets if to dump in canonical form.
    Though there is no information and/or specification regarding "canonical form", if enabled (according to experiment shown at the wiki), the dumped file looks as if:
    - setFlowStyle(FlowStyle) is set to FlowStyle.FLOW,
    - setScalarStyle(ScalarStyle) is set to ScalarStyle.DOUBLE_QUOTED,
    - setMultilineStyle(boolean) is enabled,
    - setMaxSimpleKeyLength(int) is set to 1,
    - setStartMarker(boolean) is enabled.
    Enabling this option might overwrite those settings as well, detailed behaviour is not documented.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_CANONICAL
    Parent method: DumpSettingsBuilder.setCanonical(boolean)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): canonical form
    Parameters:
    
    canonical - if to use canonical form
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setCanonical(boolean)
  - setMultilineStyle
```
public DumperSettings.Builder setMultilineStyle(boolean multilineStyle)
```
    Sets if to separate content of the document using newlines to make the dumped file somewhat readable; has effect if and only if the flow style is set to FlowStyle.FLOW.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_MULTILINE_FORMAT
    Parent method: DumpSettingsBuilder.setMultiLineFlow(boolean)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): -
    
    Parameters:
    
    multilineStyle - if to use multiline format
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setMultiLineFlow(boolean)
  - setEncoding
```
public DumperSettings.Builder setEncoding(@NotNull
                                          DumperSettings.Encoding encoding)
```
    Sets the encoding to use.
    For additional information regarding this option and charsets, please refer to documentation of the parent method listed below.
    Default: DEFAULT_ENCODING
    Parent method: DumpSettingsBuilder.setUseUnicodeEncoding(boolean)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): character sets
    
    Parameters:
    
    encoding - the encoding to use
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setUseUnicodeEncoding(boolean)
  - setIndentation
```
public DumperSettings.Builder setIndentation(int spaces)
```
    Sets how many spaces to use per one indent = one level in YAML indentation hierarchy.
    For additional information please refer to documentation of the parent method listed below.
    Default: DEFAULT_INDENTATION
    Parent method: DumpSettingsBuilder.setIndent(int)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): indentation
    
    Parameters:
    
    spaces - amount of spaces per one indentation level
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setUseUnicodeEncoding(boolean), docs for the wrapped method
  - setIndicatorIndentation
```
public DumperSettings.Builder setIndicatorIndentation(int spaces)
```
    Sets how many spaces to use per one indentation level for indicators. If the given value is less than or equal to 0, disables indicator indentation.
    For additional information regarding this option and indicators, please refer to documentation of the parent method listed below.
    Default: DEFAULT_INDICATOR_INDENTATION
    Parent method: DumpSettingsBuilder.setIndent(int)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): indentation, indicators
    
    Parameters:
    
    spaces - amount of spaces to use to indent indicators
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setIndicatorIndent(int), docs for the wrapped method
  - setLineWidth
```
public DumperSettings.Builder setLineWidth(int width)
```
    Sets the preferred line width. If any scalar makes the line longer than the given width, the dumper attempts to break the line at the nearest (next) applicable whitespace, if any.
    If the given value is less than or equal to 0, disables the limit and therefore, allows for theoretically unlimited line lengths (up to Integer.MAX_VALUE).
    For additional information, please refer to documentation of the parent method listed below.
    Default: DEFAULT_MAX_LINE_WIDTH
    Parent method: DumpSettingsBuilder.setWidth(int)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): -
    
    Parameters:
    
    width - preferred line width
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setWidth(int), docs for the wrapped method
  - setLineBreak
```
public DumperSettings.Builder setLineBreak(@NotNull
                                           String lineBreak)
```
    Sets the line break appended at the end of each line.
    For additional information, please refer to documentation of the parent method listed below.
    Default: defined by the parent method
    Parent method: DumpSettingsBuilder.setBestLineBreak(String)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): -
    
    Parameters:
    
    lineBreak - line break
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setBestLineBreak(String)
  - setMaxSimpleKeyLength
```
public DumperSettings.Builder setMaxSimpleKeyLength(int length)
```
    Sets the maximum length a key can (in serialized form, also applies to flow sequence and map keys) have to be printed in simple format (without the explicit key indicator ?).
    If the given value is less than or equal to 0, disables the limit and therefore, allows for keys of length up to 1024 (limit enforced by the YAML spec). If any value greater than 1018 is given, an IllegalArgumentException will be thrown (not a typo - the limit here is lower as there is some "processing").
    For additional information, please refer to documentation of the parent method listed below.
    Default: DEFAULT_MAX_SIMPLE_KEY_LENGTH
    Parent method: DumpSettingsBuilder.setMaxSimpleKeyLength(int)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): explicit keys
    
    Parameters:
    
    length - maximum length for simple key format
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setMaxSimpleKeyLength(int)
  - setEscapeUnprintable
```
public DumperSettings.Builder setEscapeUnprintable(boolean escape)
```
    Sets if strings containing unprintable characters should have those characters escaped, or the whole string dumped as binary data.
    For additional information, please refer to documentation of the parent method listed below.
    Default: DEFAULT_ESCAPE_UNPRINTABLE
    Parent method: DumpSettingsBuilder.setNonPrintableStyle(NonPrintableStyle)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): character sets
    
    Parameters:
    
    escape - if to escape rather than dumping as binary
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setNonPrintableStyle(NonPrintableStyle)
  - setUnprintableStyle
```
public DumperSettings.Builder setUnprintableStyle(@NotNull
                                                  org.snakeyaml.engine.v2.common.NonPrintableStyle style)
```
    Sets if strings containing unprintable characters should have those characters escaped, or the whole string dumped as binary data.
    For additional information, please refer to documentation of the parent method listed below.
    Default: corresponding to DEFAULT_ESCAPE_UNPRINTABLE
    Alias method: setEscapeUnprintable(boolean)
    Parent method: DumpSettingsBuilder.setNonPrintableStyle(NonPrintableStyle)
    Parent method docs (v2.3): click
    Related YAML spec (v1.2.2): character sets
    
    Parameters:
    
    style - style to use
    
    Returns:
    
    the builder
    
    See Also:
    
    DumpSettingsBuilder.setNonPrintableStyle(NonPrintableStyle)
  - build
```
public DumperSettings build()
```
    Builds the settings.
    
    Returns:
    
    the settings

Class DumperSettings.Builder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ANCHOR_GENERATOR

DEFAULT_FLOW_STYLE

DEFAULT_SCALAR_STYLE

DEFAULT_START_MARKER

DEFAULT_END_MARKER

DEFAULT_ROOT_TAG

DEFAULT_CANONICAL

DEFAULT_MULTILINE_FORMAT

DEFAULT_ENCODING

DEFAULT_INDENTATION

DEFAULT_INDICATOR_INDENTATION

DEFAULT_MAX_LINE_WIDTH

DEFAULT_MAX_SIMPLE_KEY_LENGTH

DEFAULT_ESCAPE_UNPRINTABLE

Method Detail

setAnchorGenerator

setFlowStyle

setScalarStyle

setStartMarker

setEndMarker

setScalarResolver

setRootTag

setYamlDirective

setTagDirectives

setCanonicalForm

setMultilineStyle

setEncoding

setIndentation

setIndicatorIndentation

setLineWidth

setLineBreak

setMaxSimpleKeyLength

setEscapeUnprintable

setUnprintableStyle

build