dev.dejvokep.boostedyaml.settings.dumper

Class DumperSettings

java.lang.Object

dev.dejvokep.boostedyaml.settings.dumper.DumperSettings

All Implemented Interfaces:

Settings

public class DumperSettings
extends Object
implements Settings

Dumper settings cover all options related explicitly (only) to file dumping.

Settings introduced by BoostedYAML follow builder design pattern, e.g. you may build your own settings using DumperSettings.builder() //configure// .build()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DumperSettings.Builder 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.
static class	DumperSettings.Encoding Represents supported encoding.

Field Summary

Fields

Modifier and Type	Field and Description
static DumperSettings	DEFAULT Default dumper settings.

Method Summary

Modifier and Type	Method and Description
org.snakeyaml.engine.v2.api.DumpSettings	buildEngineSettings() Builds the SnakeYAML Engine settings.
static DumperSettings.Builder	builder() Returns a new builder.
static DumperSettings.Builder	builder(DumperSettings settings) Returns a new builder with the same configuration as the given settings.
static DumperSettings.Builder	builder(org.snakeyaml.engine.v2.api.DumpSettingsBuilder builder) Creates and returns a new builder from the given, already created SnakeYAML Engine settings builder.
org.snakeyaml.engine.v2.common.ScalarStyle	getStringStyle() Returns the style to use for String instances.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final DumperSettings DEFAULT

Default dumper settings.

Method Detail

buildEngineSettings

public org.snakeyaml.engine.v2.api.DumpSettings buildEngineSettings()

Builds the SnakeYAML Engine settings.

Returns:

the new settings

getStringStyle

public org.snakeyaml.engine.v2.common.ScalarStyle getStringStyle()

Returns the style to use for String instances.

Returns:

the style to use for String instances

builder

public static DumperSettings.Builder builder()

Returns a new builder.

Returns:

the new builder

builder

public static DumperSettings.Builder builder(org.snakeyaml.engine.v2.api.DumpSettingsBuilder builder)

Creates and returns a new builder from the given, already created SnakeYAML Engine settings builder.

Note that the given builder is not cloned, so it is in the caller's best interest to never change it's settings from now on.

Please note that DumperSettings.Builder.setAnchorGenerator(Supplier) still has to be called (if you want to alter the default), as they are not part of the Engine's settings.

Parameters:

builder - the underlying builder

Returns:

the new builder

builder

public static DumperSettings.Builder builder(DumperSettings settings)

Returns a new builder with the same configuration as the given settings.

Parameters:

settings - preset settings

Returns:

the new builder