java.lang.Object
- org.snakeyaml.engine.v2.api.DumpSettings

```
public final class DumpSettings
extends java.lang.Object
```
Immutable configuration for serialisation. Description for all the fields can be found in the builder

Field Summary

Fields
Modifier and Type	Field	Description
`private AnchorGenerator`	`anchorGenerator`
`private java.lang.String`	`bestLineBreak`
`private boolean`	`canonical`
`private java.util.Map<SettingKey,java.lang.Object>`	`customProperties`
`private FlowStyle`	`defaultFlowStyle`
`private ScalarStyle`	`defaultScalarStyle`
`private boolean`	`dumpComments`
`private boolean`	`explicitEnd`
`private java.util.Optional<Tag>`	`explicitRootTag`
`private boolean`	`explicitStart`
`private int`	`indent`
`private boolean`	`indentWithIndicator`
`private int`	`indicatorIndent`
`private int`	`maxSimpleKeyLength`
`private boolean`	`multiLineFlow`
`private NonPrintableStyle`	`nonPrintableStyle`
`private Schema`	`schema`
`private boolean`	`splitLines`
`private java.util.Map<java.lang.String,java.lang.String>`	`tagDirective`
`private boolean`	`useUnicodeEncoding`
`private int`	`width`
`private java.util.Optional<SpecVersion>`	`yamlDirective`

Constructor Summary

Constructors
Constructor	Description
DumpSettings(boolean explicitStart, boolean explicitEnd, java.util.Optional<Tag> explicitRootTag, AnchorGenerator anchorGenerator, java.util.Optional<SpecVersion> yamlDirective, java.util.Map<java.lang.String,java.lang.String> tagDirective, FlowStyle defaultFlowStyle, ScalarStyle defaultScalarStyle, NonPrintableStyle nonPrintableStyle, Schema schema, boolean canonical, boolean multiLineFlow, boolean useUnicodeEncoding, int indent, int indicatorIndent, int width, java.lang.String bestLineBreak, boolean splitLines, int maxSimpleKeyLength, java.util.Map<SettingKey,java.lang.Object> customProperties, boolean indentWithIndicator, boolean dumpComments)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DumpSettingsBuilder`	`builder()`
`AnchorGenerator`	`getAnchorGenerator()`
`java.lang.String`	`getBestLineBreak()`
`java.lang.Object`	`getCustomProperty(SettingKey key)`
`FlowStyle`	`getDefaultFlowStyle()`
`ScalarStyle`	`getDefaultScalarStyle()`
`boolean`	`getDumpComments()`
`java.util.Optional<Tag>`	`getExplicitRootTag()`
`int`	`getIndent()`
`boolean`	`getIndentWithIndicator()`
`int`	`getIndicatorIndent()`
`int`	`getMaxSimpleKeyLength()`
`NonPrintableStyle`	`getNonPrintableStyle()`
`Schema`	`getSchema()`
`java.util.Map<java.lang.String,java.lang.String>`	`getTagDirective()`
`int`	`getWidth()`
`java.util.Optional<SpecVersion>`	`getYamlDirective()`
`boolean`	`isCanonical()`
`boolean`	`isExplicitEnd()`
`boolean`	`isExplicitStart()`
`boolean`	`isMultiLineFlow()`
`boolean`	`isSplitLines()`
`boolean`	`isUseUnicodeEncoding()`

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

Field Detail

explicitStart
```
private final boolean explicitStart
```

explicitEnd
```
private final boolean explicitEnd
```

nonPrintableStyle

private final NonPrintableStyle nonPrintableStyle

explicitRootTag

private final java.util.Optional<Tag> explicitRootTag

anchorGenerator

private final AnchorGenerator anchorGenerator

yamlDirective

private final java.util.Optional<SpecVersion> yamlDirective

tagDirective

private final java.util.Map<java.lang.String,java.lang.String> tagDirective

defaultFlowStyle

private final FlowStyle defaultFlowStyle

defaultScalarStyle

private final ScalarStyle defaultScalarStyle

canonical
```
private final boolean canonical
```

multiLineFlow
```
private final boolean multiLineFlow
```

useUnicodeEncoding

private final boolean useUnicodeEncoding

indent
```
private final int indent
```

indicatorIndent
```
private final int indicatorIndent
```

width
```
private final int width
```

bestLineBreak

private final java.lang.String bestLineBreak

splitLines
```
private final boolean splitLines
```

maxSimpleKeyLength
```
private final int maxSimpleKeyLength
```

indentWithIndicator

private final boolean indentWithIndicator

dumpComments
```
private final boolean dumpComments
```

schema
```
private final Schema schema
```

customProperties

private final java.util.Map<SettingKey,java.lang.Object> customProperties

Constructor Detail

DumpSettings

DumpSettings(boolean explicitStart,
             boolean explicitEnd,
             java.util.Optional<Tag> explicitRootTag,
             AnchorGenerator anchorGenerator,
             java.util.Optional<SpecVersion> yamlDirective,
             java.util.Map<java.lang.String,java.lang.String> tagDirective,
             FlowStyle defaultFlowStyle,
             ScalarStyle defaultScalarStyle,
             NonPrintableStyle nonPrintableStyle,
             Schema schema,
             boolean canonical,
             boolean multiLineFlow,
             boolean useUnicodeEncoding,
             int indent,
             int indicatorIndent,
             int width,
             java.lang.String bestLineBreak,
             boolean splitLines,
             int maxSimpleKeyLength,
             java.util.Map<SettingKey,java.lang.Object> customProperties,
             boolean indentWithIndicator,
             boolean dumpComments)

Method Detail

builder

public static DumpSettingsBuilder builder()

getDefaultFlowStyle

public FlowStyle getDefaultFlowStyle()

getDefaultScalarStyle

public ScalarStyle getDefaultScalarStyle()

isExplicitStart
```
public boolean isExplicitStart()
```

getAnchorGenerator

public AnchorGenerator getAnchorGenerator()

isExplicitEnd
```
public boolean isExplicitEnd()
```

getExplicitRootTag

public java.util.Optional<Tag> getExplicitRootTag()

getYamlDirective

public java.util.Optional<SpecVersion> getYamlDirective()

getTagDirective

public java.util.Map<java.lang.String,java.lang.String> getTagDirective()

isCanonical
```
public boolean isCanonical()
```

isMultiLineFlow
```
public boolean isMultiLineFlow()
```

isUseUnicodeEncoding
```
public boolean isUseUnicodeEncoding()
```

getIndent
```
public int getIndent()
```

getIndicatorIndent
```
public int getIndicatorIndent()
```

getWidth
```
public int getWidth()
```

getBestLineBreak

public java.lang.String getBestLineBreak()

isSplitLines
```
public boolean isSplitLines()
```

getMaxSimpleKeyLength
```
public int getMaxSimpleKeyLength()
```

getNonPrintableStyle

public NonPrintableStyle getNonPrintableStyle()

getCustomProperty

public java.lang.Object getCustomProperty(SettingKey key)

getIndentWithIndicator

public boolean getIndentWithIndicator()

getDumpComments
```
public boolean getDumpComments()
```

getSchema
```
public Schema getSchema()
```

Class DumpSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

explicitStart

explicitEnd

nonPrintableStyle

explicitRootTag

anchorGenerator

yamlDirective

tagDirective

defaultFlowStyle

defaultScalarStyle

canonical

multiLineFlow

useUnicodeEncoding

indent

indicatorIndent

width

bestLineBreak

splitLines

maxSimpleKeyLength

indentWithIndicator

dumpComments

schema

customProperties

Constructor Detail

DumpSettings

Method Detail

builder

getDefaultFlowStyle

getDefaultScalarStyle

isExplicitStart

getAnchorGenerator

isExplicitEnd

getExplicitRootTag

getYamlDirective

getTagDirective

isCanonical

isMultiLineFlow

isUseUnicodeEncoding

getIndent

getIndicatorIndent

getWidth

getBestLineBreak

isSplitLines

getMaxSimpleKeyLength

getNonPrintableStyle

getCustomProperty

getIndentWithIndicator

getDumpComments

getSchema