Package org.snakeyaml.engine.v2.common
Enum ScalarStyle
- java.lang.Object
-
- java.lang.Enum<ScalarStyle>
-
- org.snakeyaml.engine.v2.common.ScalarStyle
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ScalarStyle>
public enum ScalarStyle extends java.lang.Enum<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.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DOUBLE_QUOTED
Double quoted scalarFOLDED
Folded scalarLITERAL
Literal scalarPLAIN
Plain scalarSINGLE_QUOTED
Single quoted scalar
-
Field Summary
Fields Modifier and Type Field Description private java.util.Optional<java.lang.Character>
styleOpt
-
Constructor Summary
Constructors Modifier Constructor Description private
ScalarStyle(java.util.Optional<java.lang.Character> style)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
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.
-
-
-
Enum Constant Detail
-
DOUBLE_QUOTED
public static final ScalarStyle DOUBLE_QUOTED
Double quoted scalar
-
SINGLE_QUOTED
public static final ScalarStyle SINGLE_QUOTED
Single quoted scalar
-
LITERAL
public static final ScalarStyle LITERAL
Literal scalar
-
FOLDED
public static final ScalarStyle FOLDED
Folded scalar
-
PLAIN
public static final ScalarStyle PLAIN
Plain scalar
-
-
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 namejava.lang.NullPointerException
- if the argument is null
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<ScalarStyle>
-
-