SnakeYAML Engine 2.10 · org.snakeyaml.engine.v2.common.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.

Field Summary

Modifier and Type	Field and Description
public static final ScalarStyle	DOUBLE_QUOTED Double quoted scalar
public static final ScalarStyle	FOLDED Folded scalar
public static final ScalarStyle	JSON_SCALAR_STYLE Mixture of scalar styles to dump JSON format.
public static final ScalarStyle	LITERAL Literal scalar
public static final ScalarStyle	PLAIN Plain scalar
public static final ScalarStyle	SINGLE_QUOTED Single quoted scalar
private final Optional<Character>	styleOpt

Constructor Summary

Access	Constructor and Description
private	ScalarStyle(Optional<Character> style)

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 ScalarStyle	valueOf(String name)
public static 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 ScalarStyle DOUBLE_QUOTED Double quoted scalar

FOLDED	back to summary
public static final ScalarStyle FOLDED Folded scalar

JSON_SCALAR_STYLE	back to summary
public static final ScalarStyle JSON_SCALAR_STYLE Mixture of scalar styles to dump JSON format. Double-quoted style for !!str, !!binary, !!timestamp. Plain style - for !!bool, !!float, !!int, !!null These are never dumped - !!merge, !!value, !!yaml

LITERAL	back to summary
public static final ScalarStyle LITERAL Literal scalar

PLAIN	back to summary
public static final ScalarStyle PLAIN Plain scalar

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

styleOpt	back to summary
private final Optional<Character> styleOpt

Constructor Detail

ScalarStyle	back to summary
private ScalarStyle(Optional<Character> style)

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. Annotations @Override

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.

Annotations

@Override

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

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