Modifier and Type	Class and Description
public static enum	DumperOptions.FlowStyle Block styles use indentation to denote nesting and scope within the document.
public static enum	DumperOptions.LineBreak Platform dependent line break.
public static enum	DumperOptions.NonPrintableStyle the way to serialize non-printable
public static enum	DumperOptions.ScalarStyle YAML provides a rich set of scalar styles.
public static enum	DumperOptions.Version Specification version.

Modifier and Type	Field and Description
private boolean	allowReadOnlyProperties
private boolean	allowUnicode
private AnchorGenerator	anchorGenerator
private int	bestWidth
private boolean	canonical
private DumperOptions.FlowStyle	defaultFlowStyle
private DumperOptions.ScalarStyle	defaultStyle
private boolean	explicitEnd
private boolean	explicitStart
private int	indent
private boolean	indentWithIndicator
private int	indicatorIndent
private DumperOptions.LineBreak	lineBreak
private int	maxSimpleKeyLength
private DumperOptions.NonPrintableStyle	nonPrintableStyle
private Boolean	prettyFlow
private boolean	processComments
private boolean	splitLines
private Map<String, String>	tags
private TimeZone	timeZone
private DumperOptions.Version	version

Access	Constructor and Description
public	DumperOptions()

Method Summary

Modifier and Type	Method and Description
public AnchorGenerator	Returns: generator to create anchor names getAnchorGenerator() getter
public DumperOptions.FlowStyle	Returns: flow style for collections getDefaultFlowStyle() getter
public DumperOptions.ScalarStyle	Returns: scalar style getDefaultScalarStyle() getter
public int	Returns: indent getIndent() getter
public boolean	getIndentWithIndicator()
public int	getIndicatorIndent()
public DumperOptions.LineBreak	Returns: line break to separate lines getLineBreak() getter
public int	getMaxSimpleKeyLength()
public DumperOptions.NonPrintableStyle	getNonPrintableStyle()
public boolean	Returns: true when to split lines exceeding preferred width for scalars getSplitLines() getter
public Map<String, String>	Returns: previously defined tag directives getTags() getter
public TimeZone	Returns: timezone to be used to emit Date getTimeZone() getter
public DumperOptions.Version	Returns: the expected version getVersion() getter
public int	Returns: the preferred width for scalars getWidth() getter
public boolean	Returns: false when read-only JavaBean properties are not emitted isAllowReadOnlyProperties() Report whether read-only JavaBean properties (the ones without setters) should be included in the YAML document
public boolean	Returns: false when non-ASCII is escaped isAllowUnicode() getter
public boolean	Returns: true when well established format should be dumped isCanonical() getter
public boolean	Returns: true when '...' must be printed isExplicitEnd() getter
public boolean	Returns: true when '---' must be printed isExplicitStart() getter
public boolean	Returns: true for pretty style isPrettyFlow() getter
public boolean	Returns: true when comments are not ignored and can be used after composing a Node isProcessComments() getter
public void	setAllowReadOnlyProperties(boolean - true to dump read-only JavaBean properties allowReadOnlyProperties) Set to true to include read-only JavaBean properties (the ones without setters) in the YAML document.
public void	setAllowUnicode(boolean if allowUnicode is false then all non-ASCII characters are escaped allowUnicode) Specify whether to emit non-ASCII printable Unicode characters.
public void	setAnchorGenerator(AnchorGenerator - the way to create custom anchors anchorGenerator) Provide a custom generator
public void	setCanonical(boolean true produce canonical YAML document canonical) Force the emitter to produce a canonical YAML document.
public void	setDefaultFlowStyle(DumperOptions.FlowStyle - enum for the flow style defaultFlowStyle) setter
public void	setDefaultScalarStyle(DumperOptions.ScalarStyle set the style for all scalars defaultStyle) Set default style for scalars.
public void	setExplicitEnd(boolean - true to emit '...' explicitEnd) setter - require explicit '...'
public void	setExplicitStart(boolean - true to emit '---' explicitStart) setter - require explicit '...'
public void	setIndent(int number of spaces to serve as indentation indent) Define indentation.
public void	setIndentWithIndicator(boolean - true when indent for sequences is added to general indentWithIndicator) Set to true to add the indent for sequences to the general indent
public void	setIndicatorIndent(int value to be used as indent indicatorIndent) Set number of white spaces to use for the sequence indicator '-'
public void	setLineBreak(DumperOptions.LineBreak to be used for the input lineBreak) Specify the line break to separate the lines.
public void	setMaxSimpleKeyLength(int - the limit after which the key gets explicit key indicator '?' maxSimpleKeyLength) Define max key length to use simple key (without '?') More info https://yaml.org/spec/1.1/#id934537
public void	setNonPrintableStyle(DumperOptions.NonPrintableStyle ESCAPE to force SnakeYAML to keep !!str tag for non-printable data style) When String contains non-printable characters SnakeYAML convert it to binary data with the !!binary tag.
public void	setPrettyFlow(boolean true produce pretty flow YAML document prettyFlow) Force the emitter to produce a pretty YAML document when using the flow style.
public void	setProcessComments(boolean `true` to process; `false` to ignore processComments) Set the comment processing.
public void	setSplitLines(boolean whether to split lines exceeding preferred width for scalars. splitLines) Specify whether to split lines exceeding preferred width for scalars.
public void	setTags(Map<String, String> - tag directives for the YAML document tags) setter
public void	setTimeZone(TimeZone for created Dates or null to use UTC timeZone) Set the timezone to be used for Date.
public void	setVersion(DumperOptions.Version 1.0 or 1.1 version) Of no use - it is better not to include YAML version as the directive
public void	setWidth(int the preferred width for scalars. bestWidth) Specify the preferred width to emit scalars.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowReadOnlyProperties	back to summary
private boolean allowReadOnlyProperties

allowUnicode	back to summary
private boolean allowUnicode

anchorGenerator	back to summary
private AnchorGenerator anchorGenerator

bestWidth	back to summary
private int bestWidth

canonical	back to summary
private boolean canonical

defaultFlowStyle	back to summary
private DumperOptions.FlowStyle defaultFlowStyle

defaultStyle	back to summary
private DumperOptions.ScalarStyle defaultStyle

explicitEnd	back to summary
private boolean explicitEnd

explicitStart	back to summary
private boolean explicitStart

indent	back to summary
private int indent

indentWithIndicator	back to summary
private boolean indentWithIndicator

indicatorIndent	back to summary
private int indicatorIndent

lineBreak	back to summary
private DumperOptions.LineBreak lineBreak

maxSimpleKeyLength	back to summary
private int maxSimpleKeyLength

nonPrintableStyle	back to summary
private DumperOptions.NonPrintableStyle nonPrintableStyle

prettyFlow	back to summary
private Boolean prettyFlow

processComments	back to summary
private boolean processComments

splitLines	back to summary
private boolean splitLines

tags	back to summary
private Map<String, String> tags

timeZone	back to summary
private TimeZone timeZone

version	back to summary
private DumperOptions.Version version

Constructor Detail

DumperOptions	back to summary
public DumperOptions()

Method Detail

getAnchorGenerator	back to summary
public AnchorGenerator getAnchorGenerator() getter Returns:AnchorGenerator generator to create anchor names

getAnchorGenerator

back to summary

public AnchorGenerator getAnchorGenerator()

getter

Returns:AnchorGenerator: generator to create anchor names

getDefaultFlowStyle	back to summary
public DumperOptions.FlowStyle getDefaultFlowStyle() getter Returns:DumperOptions.FlowStyle flow style for collections

getDefaultFlowStyle

back to summary

public DumperOptions.FlowStyle getDefaultFlowStyle()

getter

Returns:DumperOptions.FlowStyle: flow style for collections

getDefaultScalarStyle	back to summary
public DumperOptions.ScalarStyle getDefaultScalarStyle() getter Returns:DumperOptions.ScalarStyle scalar style

getDefaultScalarStyle

back to summary

public DumperOptions.ScalarStyle getDefaultScalarStyle()

getter

Returns:DumperOptions.ScalarStyle: scalar style

getIndent	back to summary
public int getIndent() getter Returns:int indent

getIndent

back to summary

public int getIndent()

getter

Returns:int: indent

getIndentWithIndicator	back to summary
public boolean getIndentWithIndicator()

getIndicatorIndent	back to summary
public int getIndicatorIndent()

getLineBreak	back to summary
public DumperOptions.LineBreak getLineBreak() getter Returns:DumperOptions.LineBreak line break to separate lines

getLineBreak

back to summary

public DumperOptions.LineBreak getLineBreak()

getter

Returns:DumperOptions.LineBreak: line break to separate lines

getMaxSimpleKeyLength	back to summary
public int getMaxSimpleKeyLength()

getNonPrintableStyle	back to summary
public DumperOptions.NonPrintableStyle getNonPrintableStyle()

getSplitLines	back to summary
public boolean getSplitLines() getter Returns:boolean true when to split lines exceeding preferred width for scalars

getSplitLines

back to summary

public boolean getSplitLines()

getter

Returns:boolean: true when to split lines exceeding preferred width for scalars

getTags	back to summary
public Map<String, String> getTags() getter Returns:Map<String, String> previously defined tag directives

getTags

back to summary

public Map<String, String> getTags()

getter

Returns:Map<String, String>: previously defined tag directives

getTimeZone	back to summary
public TimeZone getTimeZone() getter Returns:TimeZone timezone to be used to emit Date

getTimeZone

back to summary

public TimeZone getTimeZone()

getter

Returns:TimeZone: timezone to be used to emit Date

getVersion	back to summary
public DumperOptions.Version getVersion() getter Returns:DumperOptions.Version the expected version

getVersion

back to summary

public DumperOptions.Version getVersion()

getter

Returns:DumperOptions.Version: the expected version

getWidth	back to summary
public int getWidth() getter Returns:int the preferred width for scalars

getWidth

back to summary

public int getWidth()

getter

Returns:int: the preferred width for scalars

isAllowReadOnlyProperties	back to summary
public boolean isAllowReadOnlyProperties() Report whether read-only JavaBean properties (the ones without setters) should be included in the YAML document Returns:boolean false when read-only JavaBean properties are not emitted

isAllowReadOnlyProperties

back to summary

public boolean isAllowReadOnlyProperties()

Report whether read-only JavaBean properties (the ones without setters) should be included in the YAML document

Returns:boolean: false when read-only JavaBean properties are not emitted

isAllowUnicode	back to summary
public boolean isAllowUnicode() getter Returns:boolean false when non-ASCII is escaped

isAllowUnicode

back to summary

public boolean isAllowUnicode()

getter

Returns:boolean: false when non-ASCII is escaped

isCanonical	back to summary
public boolean isCanonical() getter Returns:boolean true when well established format should be dumped

isCanonical

back to summary

public boolean isCanonical()

getter

Returns:boolean: true when well established format should be dumped

isExplicitEnd	back to summary
public boolean isExplicitEnd() getter Returns:boolean true when '...' must be printed

isExplicitEnd

back to summary

public boolean isExplicitEnd()

getter

Returns:boolean: true when '...' must be printed

isExplicitStart	back to summary
public boolean isExplicitStart() getter Returns:boolean true when '---' must be printed

isExplicitStart

back to summary

public boolean isExplicitStart()

getter

Returns:boolean: true when '---' must be printed

isPrettyFlow	back to summary
public boolean isPrettyFlow() getter Returns:boolean true for pretty style

isPrettyFlow

back to summary

public boolean isPrettyFlow()

getter

Returns:boolean: true for pretty style

isProcessComments	back to summary
public boolean isProcessComments() getter Returns:boolean true when comments are not ignored and can be used after composing a Node

isProcessComments

back to summary

public boolean isProcessComments()

getter

Returns:boolean: true when comments are not ignored and can be used after composing a Node

setAllowReadOnlyProperties	back to summary
public void setAllowReadOnlyProperties(boolean allowReadOnlyProperties) Set to true to include read-only JavaBean properties (the ones without setters) in the YAML document. By default these properties are not included to be able to parse later the same JavaBean. Parameters allowReadOnlyProperties:boolean - true to dump read-only JavaBean properties

setAllowReadOnlyProperties

back to summary

public void setAllowReadOnlyProperties(boolean allowReadOnlyProperties)

Set to true to include read-only JavaBean properties (the ones without setters) in the YAML document. By default these properties are not included to be able to parse later the same JavaBean.

Parameters

allowReadOnlyProperties:boolean: - true to dump read-only JavaBean properties

setAllowUnicode	back to summary
public void setAllowUnicode(boolean allowUnicode) Specify whether to emit non-ASCII printable Unicode characters. The default value is true. When set to false then printable non-ASCII characters (Cyrillic, Chinese etc) will be not printed but escaped (to support ASCII terminals) Parameters allowUnicode:boolean if allowUnicode is false then all non-ASCII characters are escaped

setAllowUnicode

back to summary

public void setAllowUnicode(boolean allowUnicode)

Specify whether to emit non-ASCII printable Unicode characters. The default value is true. When set to false then printable non-ASCII characters (Cyrillic, Chinese etc) will be not printed but escaped (to support ASCII terminals)

Parameters

allowUnicode:boolean: if allowUnicode is false then all non-ASCII characters are escaped

setAnchorGenerator	back to summary
public void setAnchorGenerator(AnchorGenerator anchorGenerator) Provide a custom generator Parameters anchorGenerator:AnchorGenerator - the way to create custom anchors

setAnchorGenerator

back to summary

public void setAnchorGenerator(AnchorGenerator anchorGenerator)

Provide a custom generator

Parameters

anchorGenerator:AnchorGenerator: - the way to create custom anchors

setCanonical

back to summary

public void setCanonical(boolean canonical)

Force the emitter to produce a canonical YAML document.

Parameters

canonical:boolean: true produce canonical YAML document

setDefaultFlowStyle

back to summary

public void setDefaultFlowStyle(DumperOptions.FlowStyle defaultFlowStyle)

setter

Parameters

defaultFlowStyle:DumperOptions.FlowStyle: - enum for the flow style

setDefaultScalarStyle

back to summary

public void setDefaultScalarStyle(DumperOptions.ScalarStyle defaultStyle)

Set default style for scalars. See YAML 1.1 specification, 2.3 Scalars (http://yaml.org/spec/1.1/#id858081)

Parameters

defaultStyle:DumperOptions.ScalarStyle: set the style for all scalars

setExplicitEnd

back to summary

public void setExplicitEnd(boolean explicitEnd)

setter - require explicit '...'

Parameters

explicitEnd:boolean: - true to emit '...'

setExplicitStart

back to summary

public void setExplicitStart(boolean explicitStart)

setter - require explicit '...'

Parameters

explicitStart:boolean: - true to emit '---'

setIndent

back to summary

public void setIndent(int indent)

Define indentation. Must be within the limits (1-10)

Parameters

indent:int: number of spaces to serve as indentation

setIndentWithIndicator

back to summary

public void setIndentWithIndicator(boolean indentWithIndicator)

Set to true to add the indent for sequences to the general indent

Parameters

indentWithIndicator:boolean: - true when indent for sequences is added to general

setIndicatorIndent

back to summary

public void setIndicatorIndent(int indicatorIndent)

Set number of white spaces to use for the sequence indicator '-'

Parameters

indicatorIndent:int: value to be used as indent

setLineBreak

back to summary

public void setLineBreak(DumperOptions.LineBreak lineBreak)

Specify the line break to separate the lines. It is platform specific: Windows - "\r\n", old MacOS - "\r", Unix - "\n". The default value is the one for Unix.

Parameters

lineBreak:DumperOptions.LineBreak: to be used for the input

setMaxSimpleKeyLength

back to summary

public void setMaxSimpleKeyLength(int maxSimpleKeyLength)

Define max key length to use simple key (without '?') More info https://yaml.org/spec/1.1/#id934537

Parameters

maxSimpleKeyLength:int: - the limit after which the key gets explicit key indicator '?'

setNonPrintableStyle

back to summary

public void setNonPrintableStyle(DumperOptions.NonPrintableStyle style)

When String contains non-printable characters SnakeYAML convert it to binary data with the !!binary tag. Set this to ESCAPE to keep the !!str tag and escape the non-printable chars with \\x or \\u

Parameters

style:DumperOptions.NonPrintableStyle: ESCAPE to force SnakeYAML to keep !!str tag for non-printable data

setPrettyFlow

back to summary

public void setPrettyFlow(boolean prettyFlow)

Force the emitter to produce a pretty YAML document when using the flow style.

Parameters

prettyFlow:boolean: true produce pretty flow YAML document

setProcessComments back to summary

public void setProcessComments(boolean processComments)

Set the comment processing. By default, comments are ignored.

Parameters

processComments:boolean: true to process; false to ignore

setSplitLines

back to summary

public void setSplitLines(boolean splitLines)

Specify whether to split lines exceeding preferred width for scalars. The default is true.

Parameters

splitLines:boolean: whether to split lines exceeding preferred width for scalars.

setTags

back to summary

public void setTags(Map<String, String> tags)

setter

Parameters

tags:Map<String, String>: - tag directives for the YAML document

setTimeZone back to summary

public void setTimeZone(TimeZone timeZone)

Set the timezone to be used for Date. If set to null UTC is used.

Parameters

timeZone:TimeZone: for created Dates or null to use UTC

setVersion

back to summary

public void setVersion(DumperOptions.Version version)

Of no use - it is better not to include YAML version as the directive

Parameters

version:DumperOptions.Version: 1.0 or 1.1

setWidth

back to summary

public void setWidth(int bestWidth)

Specify the preferred width to emit scalars. When the scalar representation takes more then the preferred with the scalar will be split into a few lines. The default is 80.

Parameters

bestWidth:int: the preferred width for scalars.

org.yaml.snakeyaml back to summary

public final Enum DumperOptions.FlowStyle

Class Inheritance

extends Enum<DumperOptions.FlowStyle>

java.lang.Object
java.lang.Enum
org.yaml.snakeyaml.DumperOptions.FlowStyle

Block styles use indentation to denote nesting and scope within the document. In contrast, flow styles rely on explicit indicators to denote nesting and scope.

See Also: 3.2.3.1. Node Styles (http://yaml.org/spec/1.1)

Field Summary

Modifier and Type	Field and Description
public static final DumperOptions.FlowStyle	AUTO Auto (first block, than flow)
public static final DumperOptions.FlowStyle	BLOCK Block style
public static final DumperOptions.FlowStyle	FLOW Flow style
private final Boolean	styleBoolean

Constructor Summary

Access	Constructor and Description
private	FlowStyle(Boolean flowStyle)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static DumperOptions.FlowStyle	valueOf(String name)
public static DumperOptions.FlowStyle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

AUTO	back to summary
public static final DumperOptions.FlowStyle AUTO Auto (first block, than flow)

BLOCK	back to summary
public static final DumperOptions.FlowStyle BLOCK Block style

FLOW	back to summary
public static final DumperOptions.FlowStyle FLOW Flow style

styleBoolean	back to summary
private final Boolean styleBoolean

Constructor Detail

FlowStyle	back to summary
private FlowStyle(Boolean flowStyle)

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static DumperOptions.FlowStyle valueOf(String name)

values	back to summary
public static DumperOptions.FlowStyle[] values()

org.yaml.snakeyaml back to summary

public final Enum DumperOptions.LineBreak

Class Inheritance

extends Enum<DumperOptions.LineBreak>

java.lang.Object
java.lang.Enum
org.yaml.snakeyaml.DumperOptions.LineBreak

Platform dependent line break.

Field Summary

Modifier and Type	Field and Description
private final String	lineBreak
public static final DumperOptions.LineBreak	MAC Old Mac (should not be used !)
public static final DumperOptions.LineBreak	UNIX Linux and Mac
public static final DumperOptions.LineBreak	WIN Windows

Constructor Summary

Access	Constructor and Description
private	LineBreak(String - break lineBreak) Create

Method Summary

Modifier and Type	Method and Description
public static DumperOptions.LineBreak	Returns: detected line break getPlatformLineBreak() Get the line break used by the current Operating System
public String	Returns: the break getString() getter
public String	Returns: representation toString() Overrides java.lang.Enum.toString. for humans
public static DumperOptions.LineBreak	valueOf(String name)
public static DumperOptions.LineBreak[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

lineBreak	back to summary
private final String lineBreak

MAC	back to summary
public static final DumperOptions.LineBreak MAC Old Mac (should not be used !)

UNIX	back to summary
public static final DumperOptions.LineBreak UNIX Linux and Mac

WIN	back to summary
public static final DumperOptions.LineBreak WIN Windows

Constructor Detail

LineBreak

back to summary

private LineBreak(String lineBreak)

Create

Parameters

lineBreak:String: - break

Method Detail

getPlatformLineBreak

back to summary

public static DumperOptions.LineBreak getPlatformLineBreak()

Get the line break used by the current Operating System

Returns:DumperOptions.LineBreak: detected line break

getString

back to summary

public String getString()

getter

Returns:String: the break

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

for humans

Returns:String

representation

Annotations

@Override

valueOf	back to summary
public static DumperOptions.LineBreak valueOf(String name)

values	back to summary
public static DumperOptions.LineBreak[] values()

org.yaml.snakeyaml back to summary

public final Enum DumperOptions.NonPrintableStyle

Class Inheritance

extends Enum<DumperOptions.NonPrintableStyle>

java.lang.Object
java.lang.Enum
org.yaml.snakeyaml.DumperOptions.NonPrintableStyle

the way to serialize non-printable

Field Summary

Modifier and Type	Field and Description
public static final DumperOptions.NonPrintableStyle	BINARY Transform String to binary if it contains non-printable characters
public static final DumperOptions.NonPrintableStyle	ESCAPE Escape non-printable characters

Constructor Summary

Access	Constructor and Description
private	NonPrintableStyle()

Method Summary

Modifier and Type	Method and Description
public static DumperOptions.NonPrintableStyle	valueOf(String name)
public static DumperOptions.NonPrintableStyle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BINARY	back to summary
public static final DumperOptions.NonPrintableStyle BINARY Transform String to binary if it contains non-printable characters

ESCAPE	back to summary
public static final DumperOptions.NonPrintableStyle ESCAPE Escape non-printable characters

Constructor Detail

NonPrintableStyle	back to summary
private NonPrintableStyle()

Method Detail

valueOf	back to summary
public static DumperOptions.NonPrintableStyle valueOf(String name)

values	back to summary
public static DumperOptions.NonPrintableStyle[] values()

org.yaml.snakeyaml back to summary

public final Enum DumperOptions.ScalarStyle

Class Inheritance

extends Enum<DumperOptions.ScalarStyle>

java.lang.Object
java.lang.Enum
org.yaml.snakeyaml.DumperOptions.ScalarStyle

YAML provides a rich set of scalar styles. Block scalar styles include the literal style and the folded style; flow scalar styles include the plain style and two quoted styles, the single-quoted style and the double-quoted style. These styles offer a range of trade-offs between expressive power and readability.

See Also: Chapter 9. Scalar Styles, 2.3. Scalars

Field Summary

Modifier and Type	Field and Description
public static final DumperOptions.ScalarStyle	DOUBLE_QUOTED Double quoted scalar
public static final DumperOptions.ScalarStyle	FOLDED Folded scalar
public static final DumperOptions.ScalarStyle	LITERAL Literal scalar
public static final DumperOptions.ScalarStyle	PLAIN Plain scalar
public static final DumperOptions.ScalarStyle	SINGLE_QUOTED Single quoted scalar
private final Character	styleChar

Constructor Summary

Access	Constructor and Description
private	ScalarStyle(Character style)

Method Summary

Modifier and Type	Method and Description
public static DumperOptions.ScalarStyle	Returns: parsed style createStyle(Character - source char style) Create
public Character	Returns: the char behind the style getChar() getter
public String	Returns: for humans toString() Overrides java.lang.Enum.toString. Readable style
public static DumperOptions.ScalarStyle	valueOf(String name)
public static DumperOptions.ScalarStyle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

DOUBLE_QUOTED	back to summary
public static final DumperOptions.ScalarStyle DOUBLE_QUOTED Double quoted scalar

FOLDED	back to summary
public static final DumperOptions.ScalarStyle FOLDED Folded scalar

LITERAL	back to summary
public static final DumperOptions.ScalarStyle LITERAL Literal scalar

PLAIN	back to summary
public static final DumperOptions.ScalarStyle PLAIN Plain scalar

SINGLE_QUOTED	back to summary
public static final DumperOptions.ScalarStyle SINGLE_QUOTED Single quoted scalar

styleChar	back to summary
private final Character styleChar

Constructor Detail

ScalarStyle	back to summary
private ScalarStyle(Character style)

Method Detail

createStyle

back to summary

public static DumperOptions.ScalarStyle createStyle(Character style)

Create

Parameters

style:Character: - source char

Returns:DumperOptions.ScalarStyle

parsed style

getChar

back to summary

public Character getChar()

getter

Returns:Character: the char behind the style

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Readable style

Returns:String

for humans

Annotations

@Override

valueOf	back to summary
public static DumperOptions.ScalarStyle valueOf(String name)

values	back to summary
public static DumperOptions.ScalarStyle[] values()

org.yaml.snakeyaml back to summary

public final Enum DumperOptions.Version

Class Inheritance

extends Enum<DumperOptions.Version>

java.lang.Object
java.lang.Enum
org.yaml.snakeyaml.DumperOptions.Version

Specification version. Currently supported 1.0 and 1.1

Field Summary

Modifier and Type	Field and Description
public static final DumperOptions.Version	V1_0 1.0
public static final DumperOptions.Version	V1_1 1.1
private final Integer[]	version

Constructor Summary

Access	Constructor and Description
private	Version(Integer[] - definition version) Create

Method Summary

Modifier and Type	Method and Description
public String	Returns: representation for serialisation getRepresentation() getter
public int	Returns: major part (always 1) major() getter
public int	Returns: 0 or 1 minor() Minor part (0 or 1)
public String	Returns: for humans toString() Overrides java.lang.Enum.toString. Readable string
public static DumperOptions.Version	valueOf(String name)
public static DumperOptions.Version[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

V1_0	back to summary
public static final DumperOptions.Version V1_0 1.0

V1_1	back to summary
public static final DumperOptions.Version V1_1 1.1

version	back to summary
private final Integer[] version

Constructor Detail

Version

back to summary

private Version(Integer[] version)

Create

Parameters

version:Integer[]: - definition

Method Detail

getRepresentation

back to summary

public String getRepresentation()

getter

Returns:String: representation for serialisation

major

back to summary

public int major()

getter

Returns:int: major part (always 1)

minor

back to summary

public int minor()

Minor part (0 or 1)

Returns:int: 0 or 1

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Readable string

Returns:String

for humans

Annotations

@Override

valueOf	back to summary
public static DumperOptions.Version valueOf(String name)

values	back to summary
public static DumperOptions.Version[] values()

public Class DumperOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DumperOptions.FlowStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DumperOptions.LineBreak

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DumperOptions.NonPrintableStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DumperOptions.ScalarStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DumperOptions.Version

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail