public class DumperOptions extends Object
| Modifier and Type | Class and Description | 
|---|---|
| static class  | DumperOptions.FlowStyleBlock styles use indentation to denote nesting and scope within the
 document. | 
| static class  | DumperOptions.LineBreakPlatform dependent line break. | 
| static class  | DumperOptions.NonPrintableStyle | 
| static class  | DumperOptions.ScalarStyleYAML provides a rich set of scalar styles. | 
| static class  | DumperOptions.VersionSpecification version. | 
| Constructor and Description | 
|---|
| DumperOptions() | 
| Modifier and Type | Method and Description | 
|---|---|
| AnchorGenerator | getAnchorGenerator() | 
| DumperOptions.FlowStyle | getDefaultFlowStyle() | 
| DumperOptions.ScalarStyle | getDefaultScalarStyle() | 
| int | getIndent() | 
| boolean | getIndentWithIndicator() | 
| int | getIndicatorIndent() | 
| DumperOptions.LineBreak | getLineBreak() | 
| int | getMaxSimpleKeyLength() | 
| DumperOptions.NonPrintableStyle | getNonPrintableStyle() | 
| boolean | getSplitLines() | 
| Map<String,String> | getTags() | 
| TimeZone | getTimeZone() | 
| DumperOptions.Version | getVersion() | 
| int | getWidth() | 
| boolean | isAllowReadOnlyProperties()Report whether read-only JavaBean properties (the ones without setters)
 should be included in the YAML document | 
| boolean | isAllowUnicode() | 
| boolean | isCanonical() | 
| boolean | isExplicitEnd() | 
| boolean | isExplicitStart() | 
| boolean | isPrettyFlow() | 
| boolean | isProcessComments() | 
| 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) | 
| void | setCanonical(boolean canonical)Force the emitter to produce a canonical YAML document. | 
| void | setDefaultFlowStyle(DumperOptions.FlowStyle defaultFlowStyle) | 
| void | setDefaultScalarStyle(DumperOptions.ScalarStyle defaultStyle)Set default style for scalars. | 
| void | setExplicitEnd(boolean explicitEnd) | 
| void | setExplicitStart(boolean explicitStart) | 
| void | setIndent(int indent) | 
| 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) | 
| void | setTimeZone(TimeZone timeZone)Set the timezone to be used for Date. | 
| void | setVersion(DumperOptions.Version version) | 
| 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)
public 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)
public 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)
public DumperOptions.FlowStyle getDefaultFlowStyle()
public void setLineBreak(DumperOptions.LineBreak lineBreak)
lineBreak - to be used for the inputpublic boolean isExplicitStart()
public void setExplicitStart(boolean explicitStart)
public boolean isExplicitEnd()
public void setExplicitEnd(boolean explicitEnd)
public 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)
public 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–2021. All rights reserved.