public class DumperOptions extends Object
Modifier and Type | Class and Description |
---|---|
static class |
DumperOptions.FlowStyle
Block styles use indentation to denote nesting and scope within the document.
|
static class |
DumperOptions.LineBreak
Platform dependent line break.
|
static class |
DumperOptions.NonPrintableStyle
the way to serialize non-printable
|
static class |
DumperOptions.ScalarStyle
YAML provides a rich set of scalar styles.
|
static class |
DumperOptions.Version
Specification version.
|
Constructor and Description |
---|
DumperOptions() |
Modifier and Type | Method and Description |
---|---|
AnchorGenerator |
getAnchorGenerator()
getter
|
DumperOptions.FlowStyle |
getDefaultFlowStyle()
getter
|
DumperOptions.ScalarStyle |
getDefaultScalarStyle()
getter
|
int |
getIndent()
getter
|
boolean |
getIndentWithIndicator() |
int |
getIndicatorIndent() |
DumperOptions.LineBreak |
getLineBreak()
getter
|
int |
getMaxSimpleKeyLength() |
DumperOptions.NonPrintableStyle |
getNonPrintableStyle() |
boolean |
getSplitLines()
getter
|
Map<String,String> |
getTags()
getter
|
TimeZone |
getTimeZone()
getter
|
DumperOptions.Version |
getVersion()
getter
|
int |
getWidth()
getter
|
boolean |
isAllowReadOnlyProperties()
Report whether read-only JavaBean properties (the ones without setters) should be included in
the YAML document
|
boolean |
isAllowUnicode()
getter
|
boolean |
isCanonical()
getter
|
boolean |
isExplicitEnd()
getter
|
boolean |
isExplicitStart()
getter
|
boolean |
isPrettyFlow()
getter
|
boolean |
isProcessComments()
getter
|
void |
setAllowReadOnlyProperties(boolean allowReadOnlyProperties)
Set to true to include read-only JavaBean properties (the ones without setters) in the YAML
document.
|
void |
setAllowUnicode(boolean allowUnicode)
Specify whether to emit non-ASCII printable Unicode characters.
|
void |
setAnchorGenerator(AnchorGenerator anchorGenerator)
Provide a custom generator
|
void |
setCanonical(boolean canonical)
Force the emitter to produce a canonical YAML document.
|
void |
setDefaultFlowStyle(DumperOptions.FlowStyle defaultFlowStyle)
setter
|
void |
setDefaultScalarStyle(DumperOptions.ScalarStyle defaultStyle)
Set default style for scalars.
|
void |
setExplicitEnd(boolean explicitEnd)
setter - require explicit '...'
|
void |
setExplicitStart(boolean explicitStart)
setter - require explicit '...'
|
void |
setIndent(int indent)
Define indentation.
|
void |
setIndentWithIndicator(boolean indentWithIndicator)
Set to true to add the indent for sequences to the general indent
|
void |
setIndicatorIndent(int indicatorIndent)
Set number of white spaces to use for the sequence indicator '-'
|
void |
setLineBreak(DumperOptions.LineBreak lineBreak)
Specify the line break to separate the lines.
|
void |
setMaxSimpleKeyLength(int maxSimpleKeyLength)
Define max key length to use simple key (without '?') More info
https://yaml.org/spec/1.1/#id934537
|
void |
setNonPrintableStyle(DumperOptions.NonPrintableStyle style)
When String contains non-printable characters SnakeYAML convert it to binary data with the
!!binary tag.
|
void |
setPrettyFlow(boolean prettyFlow)
Force the emitter to produce a pretty YAML document when using the flow style.
|
void |
setProcessComments(boolean processComments)
Set the comment processing.
|
void |
setSplitLines(boolean splitLines)
Specify whether to split lines exceeding preferred width for scalars.
|
void |
setTags(Map<String,String> tags)
setter
|
void |
setTimeZone(TimeZone timeZone)
Set the timezone to be used for Date.
|
void |
setVersion(DumperOptions.Version version)
Of no use - it is better not to include YAML version as the directive
|
void |
setWidth(int bestWidth)
Specify the preferred width to emit scalars.
|
public boolean isAllowUnicode()
public void setAllowUnicode(boolean allowUnicode)
allowUnicode
- if allowUnicode is false then all non-ASCII characters are escapedpublic DumperOptions.ScalarStyle getDefaultScalarStyle()
public void setDefaultScalarStyle(DumperOptions.ScalarStyle defaultStyle)
defaultStyle
- set the style for all scalarspublic void setIndent(int indent)
indent
- number of spaces to serve as indentationpublic int getIndent()
public void setIndicatorIndent(int indicatorIndent)
indicatorIndent
- value to be used as indentpublic int getIndicatorIndent()
public boolean getIndentWithIndicator()
public void setIndentWithIndicator(boolean indentWithIndicator)
indentWithIndicator
- - true when indent for sequences is added to generalpublic void setVersion(DumperOptions.Version version)
version
- 1.0 or 1.1public DumperOptions.Version getVersion()
public void setCanonical(boolean canonical)
canonical
- true produce canonical YAML documentpublic boolean isCanonical()
public void setPrettyFlow(boolean prettyFlow)
prettyFlow
- true produce pretty flow YAML documentpublic boolean isPrettyFlow()
public void setWidth(int bestWidth)
bestWidth
- the preferred width for scalars.public int getWidth()
public void setSplitLines(boolean splitLines)
splitLines
- whether to split lines exceeding preferred width for scalars.public boolean getSplitLines()
public DumperOptions.LineBreak getLineBreak()
public void setDefaultFlowStyle(DumperOptions.FlowStyle defaultFlowStyle)
defaultFlowStyle
- - enum for the flow stylepublic DumperOptions.FlowStyle getDefaultFlowStyle()
public void setLineBreak(DumperOptions.LineBreak lineBreak)
lineBreak
- to be used for the inputpublic boolean isExplicitStart()
public void setExplicitStart(boolean explicitStart)
explicitStart
- - true to emit '---'public boolean isExplicitEnd()
public void setExplicitEnd(boolean explicitEnd)
explicitEnd
- - true to emit '...'public void setTags(Map<String,String> tags)
tags
- - tag directives for the YAML documentpublic boolean isAllowReadOnlyProperties()
public void setAllowReadOnlyProperties(boolean allowReadOnlyProperties)
allowReadOnlyProperties
- - true to dump read-only JavaBean propertiespublic TimeZone getTimeZone()
public void setTimeZone(TimeZone timeZone)
null
UTC is used.timeZone
- for created Dates or null to use UTCpublic AnchorGenerator getAnchorGenerator()
public void setAnchorGenerator(AnchorGenerator anchorGenerator)
anchorGenerator
- - the way to create custom anchorspublic int getMaxSimpleKeyLength()
public void setMaxSimpleKeyLength(int maxSimpleKeyLength)
maxSimpleKeyLength
- - the limit after which the key gets explicit key indicator '?'public void setProcessComments(boolean processComments)
processComments
- true
to process; false
to ignorepublic boolean isProcessComments()
public DumperOptions.NonPrintableStyle getNonPrintableStyle()
public void setNonPrintableStyle(DumperOptions.NonPrintableStyle style)
style
- ESCAPE to force SnakeYAML to keep !!str tag for non-printable dataCopyright © 2008–2022. All rights reserved.