Package org.yaml.snakeyaml
Enum DumperOptions.ScalarStyle
- java.lang.Object
-
- java.lang.Enum<DumperOptions.ScalarStyle>
-
- org.yaml.snakeyaml.DumperOptions.ScalarStyle
-
- All Implemented Interfaces:
Serializable
,Comparable<DumperOptions.ScalarStyle>
- Enclosing class:
- DumperOptions
public static enum DumperOptions.ScalarStyle extends 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
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DOUBLE_QUOTED
Double quoted scalarFOLDED
Folded scalarLITERAL
Literal scalarPLAIN
Plain scalarSINGLE_QUOTED
Single quoted scalar
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DumperOptions.ScalarStyle
createStyle(Character style)
CreateCharacter
getChar()
getterString
toString()
Readable stylestatic DumperOptions.ScalarStyle
valueOf(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.
-
-
-
Enum Constant Detail
-
DOUBLE_QUOTED
public static final DumperOptions.ScalarStyle DOUBLE_QUOTED
Double quoted scalar
-
SINGLE_QUOTED
public static final DumperOptions.ScalarStyle SINGLE_QUOTED
Single quoted scalar
-
LITERAL
public static final DumperOptions.ScalarStyle LITERAL
Literal scalar
-
FOLDED
public static final DumperOptions.ScalarStyle FOLDED
Folded scalar
-
PLAIN
public static final DumperOptions.ScalarStyle PLAIN
Plain scalar
-
-
Method Detail
-
values
public static DumperOptions.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 (DumperOptions.ScalarStyle c : DumperOptions.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 DumperOptions.ScalarStyle valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getChar
public Character getChar()
getter- Returns:
- the char behind the style
-
toString
public String toString()
Readable style- Overrides:
toString
in classEnum<DumperOptions.ScalarStyle>
- Returns:
- for humans
-
createStyle
public static DumperOptions.ScalarStyle createStyle(Character style)
Create- Parameters:
style
- - source char- Returns:
- parsed style
-
-