Package org.spongepowered.configurate.yaml

Enum ScalarStyle

java.lang.Object

java.lang.Enum<ScalarStyle>

org.spongepowered.configurate.yaml.ScalarStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScalarStyle>

public enum ScalarStyle
extends java.lang.Enum<ScalarStyle>

Style that can be used to represent a scalar.

Since:

4.2.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOUBLE_QUOTED	A double-quoted string.
FOLDED	Folded scalar.
LITERAL	Literal scalar.
SINGLE_QUOTED	A single-quoted string.
UNQUOTED	String without any quotation.

Method Summary

Modifier and Type	Method	Description
static ScalarStyle	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOUBLE_QUOTED

public static final ScalarStyle DOUBLE_QUOTED

A double-quoted string.

"hello world"

Since:

4.2.0

SINGLE_QUOTED

public static final ScalarStyle SINGLE_QUOTED

A single-quoted string.

'hello world'

Since:

4.2.0

UNQUOTED

public static final ScalarStyle UNQUOTED

String without any quotation.

This may be ambiguous with non-string types.

Since:

4.2.0

FOLDED

public static final ScalarStyle FOLDED

Folded scalar.

 key: >
   folded scalar
   line breaks collapsed
 

Since:

4.2.0

LITERAL

public static final ScalarStyle LITERAL

Literal scalar.

 key: |
   literal scalar
   line breaks preserved
 

Since:

4.2.0

Method Detail

values

public static ScalarStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScalarStyle c : ScalarStyle.values())
    System.out.println(c);

Returns:

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

valueOf

public static 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