Module org.yaml.snakeyaml

Package org.yaml.snakeyaml

Enum DumperOptions.ScalarStyle

java.lang.Object

java.lang.Enum<DumperOptions.ScalarStyle>

org.yaml.snakeyaml.DumperOptions.ScalarStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DumperOptions.ScalarStyle>, java.lang.constant.Constable

Enclosing class:

DumperOptions

public static enum DumperOptions.ScalarStyle
extends java.lang.Enum<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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOUBLE_QUOTED
FOLDED
LITERAL
PLAIN
SINGLE_QUOTED

Method Summary

Modifier and Type	Method	Description
static DumperOptions.ScalarStyle	createStyle(java.lang.Character style)
java.lang.Character	getChar()
java.lang.String	toString()
static DumperOptions.ScalarStyle	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DumperOptions.ScalarStyle[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DOUBLE_QUOTED

public static final DumperOptions.ScalarStyle DOUBLE_QUOTED

SINGLE_QUOTED

public static final DumperOptions.ScalarStyle SINGLE_QUOTED

LITERAL

public static final DumperOptions.ScalarStyle LITERAL

FOLDED

public static final DumperOptions.ScalarStyle FOLDED

PLAIN

public static final DumperOptions.ScalarStyle PLAIN

Method Details

values

public static DumperOptions.ScalarStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DumperOptions.ScalarStyle valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getChar

public java.lang.Character getChar()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DumperOptions.ScalarStyle>

createStyle

public static DumperOptions.ScalarStyle createStyle(java.lang.Character style)