/**
* Copyright (c) 2008-2013, http://www.snakeyaml.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.yaml.snakeyaml;
import java.util.Map;
import java.util.TimeZone;
import org.yaml.snakeyaml.emitter.Emitter;
import org.yaml.snakeyaml.emitter.ScalarAnalysis;
import org.yaml.snakeyaml.error.YAMLException;
import org.yaml.snakeyaml.nodes.Tag;
public class DumperOptions {
/**
* 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 <a href="http://yaml.org/spec/1.1/#id903915">Chapter 9. Scalar Styles</a>
* @see <a href="http://yaml.org/spec/1.1/#id858081">2.3. Scalars</a>
*/
public enum ScalarStyle {
DOUBLE_QUOTED(Character.valueOf('"')), SINGLE_QUOTED(Character.valueOf('\'')), LITERAL(Character.valueOf('|')), FOLDED(Character
.valueOf('>')), PLAIN(null);
private Character styleChar;
private ScalarStyle(final Character style) {
this.styleChar = style;
}
public Character getChar() {
return styleChar;
}
@Override
public String toString() {
return "Scalar style: '" + styleChar + "'";
}
public static ScalarStyle createStyle(final Character style) {
if (style == null) {
return PLAIN;
} else {
switch (style) {
case '"':
return DOUBLE_QUOTED;
case '\'':
return SINGLE_QUOTED;
case '|':
return LITERAL;
case '>':
return FOLDED;
default:
throw new YAMLException("Unknown scalar style character: " + style);
}
}
}
}
/**
* 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 <a href="http://www.yaml.org/spec/current.html#id2509255">3.2.3.1. Node Styles (http://yaml.org/spec/1.1)</a>
*/
public enum FlowStyle {
FLOW(Boolean.TRUE), BLOCK(Boolean.FALSE), AUTO(null);
private Boolean styleBoolean;
private FlowStyle(final Boolean flowStyle) {
styleBoolean = flowStyle;
}
public Boolean getStyleBoolean() {
return styleBoolean;
}
@Override
public String toString() {
return "Flow style: '" + styleBoolean + "'";
}
}
/**
* Platform dependent line break.
*/
public enum LineBreak {
WIN("\r\n"), MAC("\r"), UNIX("\n");
private String lineBreak;
private LineBreak(final String lineBreak) {
this.lineBreak = lineBreak;
}
public String getString() {
return lineBreak;
}
@Override
public String toString() {
return "Line break: " + name();
}
public static LineBreak getPlatformLineBreak() {
String platformLineBreak = System.getProperty("line.separator");
for (LineBreak lb : values()) {
if (lb.lineBreak.equals(platformLineBreak)) {
return lb;
}
}
return LineBreak.UNIX;
}
}
/**
* Specification version. Currently supported 1.0 and 1.1
*/
public enum Version {
V1_0(new Integer[] { 1, 0 }), V1_1(new Integer[] { 1, 1 });
private Integer[] version;
private Version(final Integer[] version) {
this.version = version;
}
public Integer[] getArray() {
return version;
}
public String getRepresentation() {
return version[0] + "." + version[1];
}
@Override
public String toString() {
return "Version: " + getRepresentation();
}
}
private ScalarStyle defaultStyle = ScalarStyle.PLAIN;
private FlowStyle defaultFlowStyle = FlowStyle.AUTO;
private boolean canonical = false;
private boolean allowUnicode = true;
private boolean allowReadOnlyProperties = false;
private int indent = 2;
private int bestWidth = 80;
private LineBreak lineBreak = LineBreak.UNIX;
private boolean explicitStart = false;
private boolean explicitEnd = false;
private TimeZone timeZone = null;
/**
* @deprecated do not use explicit root Tag
*/
@Deprecated
private Tag explicitRoot = null;
private Version version = null;
private Map<String, String> tags = null;
private Boolean prettyFlow = false;
public boolean isAllowUnicode() {
return allowUnicode;
}
/**
* Specify whether to emit non-ASCII printable Unicode characters (to support ASCII terminals). The default value is true.
*
* @param allowUnicode
* if allowUnicode is false then all non-ASCII characters are escaped
*/
public void setAllowUnicode(final boolean allowUnicode) {
this.allowUnicode = allowUnicode;
}
public ScalarStyle getDefaultScalarStyle() {
return defaultStyle;
}
/**
* Set default style for scalars. See YAML 1.1 specification, 2.3 Scalars (http://yaml.org/spec/1.1/#id858081)
*
* @param defaultStyle
* set the style for all scalars
*/
public void setDefaultScalarStyle(final ScalarStyle defaultStyle) {
if (defaultStyle == null) {
throw new NullPointerException("Use ScalarStyle enum.");
}
this.defaultStyle = defaultStyle;
}
public void setIndent(final int indent) {
if (indent < Emitter.MIN_INDENT) {
throw new YAMLException("Indent must be at least " + Emitter.MIN_INDENT);
}
if (indent > Emitter.MAX_INDENT) {
throw new YAMLException("Indent must be at most " + Emitter.MAX_INDENT);
}
this.indent = indent;
}
public int getIndent() {
return this.indent;
}
public void setVersion(final Version version) {
this.version = version;
}
public Version getVersion() {
return this.version;
}
/**
* Force the emitter to produce a canonical YAML document.
*
* @param canonical
* true produce canonical YAML document
*/
public void setCanonical(final boolean canonical) {
this.canonical = canonical;
}
public boolean isCanonical() {
return this.canonical;
}
/**
* Force the emitter to produce a pretty YAML document when using the flow style.
*
* @param prettyFlow
* true produce pretty flow YAML document
*/
public void setPrettyFlow(final boolean prettyFlow) {
this.prettyFlow = prettyFlow;
}
public boolean isPrettyFlow() {
return this.prettyFlow;
}
/**
* 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.
*
* @param bestWidth
* the preferred with for scalars.
*/
public void setWidth(final int bestWidth) {
this.bestWidth = bestWidth;
}
public int getWidth() {
return this.bestWidth;
}
public LineBreak getLineBreak() {
return lineBreak;
}
public void setDefaultFlowStyle(final FlowStyle defaultFlowStyle) {
if (defaultFlowStyle == null) {
throw new NullPointerException("Use FlowStyle enum.");
}
this.defaultFlowStyle = defaultFlowStyle;
}
public FlowStyle getDefaultFlowStyle() {
return defaultFlowStyle;
}
/**
* @deprecated do not use explicit root Tag
*/
@Deprecated
public Tag getExplicitRoot() {
return explicitRoot;
}
/**
* @param expRoot
* tag to be used for the root node. (JavaBeans may use Tag.MAP="tag:yaml.org,2002:map")
* @deprecated use Tag instead of String
*/
@Deprecated
public void setExplicitRoot(final String expRoot) {
setExplicitRoot(new Tag(expRoot));
}
/**
* @param expRoot
* tag to be used for the root node. (JavaBeans may use Tag.MAP="tag:yaml.org,2002:map")
* @deprecated do not use explicit root Tag
*/
@Deprecated
public void setExplicitRoot(final Tag expRoot) {
if (expRoot == null) {
throw new NullPointerException("Root tag must be specified.");
}
this.explicitRoot = expRoot;
}
/**
* 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.
*/
public void setLineBreak(final LineBreak lineBreak) {
if (lineBreak == null) {
throw new NullPointerException("Specify line break.");
}
this.lineBreak = lineBreak;
}
public boolean isExplicitStart() {
return explicitStart;
}
public void setExplicitStart(final boolean explicitStart) {
this.explicitStart = explicitStart;
}
public boolean isExplicitEnd() {
return explicitEnd;
}
public void setExplicitEnd(final boolean explicitEnd) {
this.explicitEnd = explicitEnd;
}
public Map<String, String> getTags() {
return tags;
}
// TODO should use Tag ???
public void setTags(final Map<String, String> tags) {
this.tags = tags;
}
/**
* Define the ScalarStyle to be used for emitting scalars
*
* @param analysis
* - Scalar meta data
* @param style
* - automatically detected style
* @return ScalarStyle to be used for scalar
* @deprecated it was implemented as a quick fix for issue 29
*/
@Deprecated
public ScalarStyle calculateScalarStyle(final ScalarAnalysis analysis, final ScalarStyle style) {
return style;
}
/**
* Report whether read-only JavaBean properties (the ones without setters) should be included in the YAML document
*
* @return false when read-only JavaBean properties are not emitted
*/
public boolean isAllowReadOnlyProperties() {
return 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.
*
* @param allowReadOnlyProperties
* - true to dump read-only JavaBean properties
*/
public void setAllowReadOnlyProperties(final boolean allowReadOnlyProperties) {
this.allowReadOnlyProperties = allowReadOnlyProperties;
}
public TimeZone getTimeZone() {
return timeZone;
}
/**
* Set the timezone to be used for Date. If set to <code>null</code> UTC is used.
*/
public void setTimeZone(final TimeZone timeZone) {
this.timeZone = timeZone;
}
}