Top Description Fields Constructors Methods
org.snakeyaml.engine.v2.api

public final Class DumpSettings

extends Object
Class Inheritance
Imports
java.util.Map, .Optional, org.snakeyaml.engine.v2.common.FlowStyle, .NonPrintableStyle, .ScalarStyle, .SpecVersion, org.snakeyaml.engine.v2.nodes.Tag, org.snakeyaml.engine.v2.schema.Schema, org.snakeyaml.engine.v2.serializer.AnchorGenerator
Immutable configuration for serialisation. Description for all the fields can be found in the builder

Field Summary

Modifier and TypeField and Description
private final AnchorGenerator
anchorGenerator

private final String
bestLineBreak

private final boolean
canonical

private final Map<SettingKey, Object>
customProperties

private final FlowStyle
defaultFlowStyle

private final ScalarStyle
defaultScalarStyle

private final Boolean
dereferenceAliases

private final boolean
dumpComments

private final boolean
explicitEnd

private final Optional<Tag>
explicitRootTag

private final boolean
explicitStart

private final int
indent

private final boolean
indentWithIndicator

private final int
indicatorIndent

private final int
maxSimpleKeyLength

private final boolean
multiLineFlow

private final NonPrintableStyle
nonPrintableStyle

private final Schema
schema

private final boolean
splitLines

private final Map<String, String>
tagDirective

private final boolean
useUnicodeEncoding

private final int
width

private final Optional<SpecVersion>
yamlDirective

Constructor Summary

AccessConstructor and Description
pack-priv
DumpSettings(boolean explicitStart, boolean explicitEnd, Optional<Tag> explicitRootTag, AnchorGenerator anchorGenerator, Optional<SpecVersion> yamlDirective, Map<String, String> tagDirective, FlowStyle defaultFlowStyle, ScalarStyle defaultScalarStyle, NonPrintableStyle nonPrintableStyle, Schema schema, Boolean dereferenceAliases, boolean canonical, boolean multiLineFlow, boolean useUnicodeEncoding, int indent, int indicatorIndent, int width, String bestLineBreak, boolean splitLines, int maxSimpleKeyLength, Map<SettingKey, Object> customProperties, boolean indentWithIndicator, boolean dumpComments)

Method Summary

Modifier and TypeMethod and Description
public static DumpSettingsBuilder
builder()

public AnchorGenerator
getAnchorGenerator()

public String
getBestLineBreak()

public Object
getCustomProperty(SettingKey key)

public FlowStyle
getDefaultFlowStyle()

public ScalarStyle
getDefaultScalarStyle()

public boolean
getDumpComments()

public Optional<Tag>
getExplicitRootTag()

public int
getIndent()

public boolean
getIndentWithIndicator()

public int
getIndicatorIndent()

public int
getMaxSimpleKeyLength()

public NonPrintableStyle
getNonPrintableStyle()

public Schema
getSchema()

public Map<String, String>
getTagDirective()

public int
getWidth()

public Optional<SpecVersion>
getYamlDirective()

public boolean
isCanonical()

public Boolean
isDereferenceAliases()

public boolean
isExplicitEnd()

public boolean
isExplicitStart()

public boolean
isMultiLineFlow()

public boolean
isSplitLines()

public boolean
isUseUnicodeEncoding()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

anchorGeneratorback to summary
private final AnchorGenerator anchorGenerator
bestLineBreakback to summary
private final String bestLineBreak
canonicalback to summary
private final boolean canonical
customPropertiesback to summary
private final Map<SettingKey, Object> customProperties
defaultFlowStyleback to summary
private final FlowStyle defaultFlowStyle
defaultScalarStyleback to summary
private final ScalarStyle defaultScalarStyle
dereferenceAliasesback to summary
private final Boolean dereferenceAliases
dumpCommentsback to summary
private final boolean dumpComments
explicitEndback to summary
private final boolean explicitEnd
explicitRootTagback to summary
private final Optional<Tag> explicitRootTag
explicitStartback to summary
private final boolean explicitStart
indentback to summary
private final int indent
indentWithIndicatorback to summary
private final boolean indentWithIndicator
indicatorIndentback to summary
private final int indicatorIndent
maxSimpleKeyLengthback to summary
private final int maxSimpleKeyLength
multiLineFlowback to summary
private final boolean multiLineFlow
nonPrintableStyleback to summary
private final NonPrintableStyle nonPrintableStyle
schemaback to summary
private final Schema schema
splitLinesback to summary
private final boolean splitLines
tagDirectiveback to summary
private final Map<String, String> tagDirective
useUnicodeEncodingback to summary
private final boolean useUnicodeEncoding
widthback to summary
private final int width
yamlDirectiveback to summary
private final Optional<SpecVersion> yamlDirective

Constructor Detail

DumpSettingsback to summary
pack-priv DumpSettings(boolean explicitStart, boolean explicitEnd, Optional<Tag> explicitRootTag, AnchorGenerator anchorGenerator, Optional<SpecVersion> yamlDirective, Map<String, String> tagDirective, FlowStyle defaultFlowStyle, ScalarStyle defaultScalarStyle, NonPrintableStyle nonPrintableStyle, Schema schema, Boolean dereferenceAliases, boolean canonical, boolean multiLineFlow, boolean useUnicodeEncoding, int indent, int indicatorIndent, int width, String bestLineBreak, boolean splitLines, int maxSimpleKeyLength, Map<SettingKey, Object> customProperties, boolean indentWithIndicator, boolean dumpComments)

Method Detail

builderback to summary
public static DumpSettingsBuilder builder()
getAnchorGeneratorback to summary
public AnchorGenerator getAnchorGenerator()
getBestLineBreakback to summary
public String getBestLineBreak()
getCustomPropertyback to summary
public Object getCustomProperty(SettingKey key)
getDefaultFlowStyleback to summary
public FlowStyle getDefaultFlowStyle()
getDefaultScalarStyleback to summary
public ScalarStyle getDefaultScalarStyle()
getDumpCommentsback to summary
public boolean getDumpComments()
getExplicitRootTagback to summary
public Optional<Tag> getExplicitRootTag()
getIndentback to summary
public int getIndent()
getIndentWithIndicatorback to summary
public boolean getIndentWithIndicator()
getIndicatorIndentback to summary
public int getIndicatorIndent()
getMaxSimpleKeyLengthback to summary
public int getMaxSimpleKeyLength()
getNonPrintableStyleback to summary
public NonPrintableStyle getNonPrintableStyle()
getSchemaback to summary
public Schema getSchema()
getTagDirectiveback to summary
public Map<String, String> getTagDirective()
getWidthback to summary
public int getWidth()
getYamlDirectiveback to summary
public Optional<SpecVersion> getYamlDirective()
isCanonicalback to summary
public boolean isCanonical()
isDereferenceAliasesback to summary
public Boolean isDereferenceAliases()
isExplicitEndback to summary
public boolean isExplicitEnd()
isExplicitStartback to summary
public boolean isExplicitStart()
isMultiLineFlowback to summary
public boolean isMultiLineFlow()
isSplitLinesback to summary
public boolean isSplitLines()
isUseUnicodeEncodingback to summary
public boolean isUseUnicodeEncoding()