Package org.cthing.escapers

Enum Class YamlEscaper.Option

java.lang.Object

java.lang.Enum<YamlEscaper.Option>

org.cthing.escapers.YamlEscaper.Option

All Implemented Interfaces:

Serializable, Comparable<YamlEscaper.Option>, Constable

Enclosing class:

YamlEscaper

public static enum YamlEscaper.Option
extends Enum<YamlEscaper.Option>

Escaping options.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ESCAPE_NON_ASCII	Escape characters above the ASCII range (i.e.

Method Summary

Modifier and Type	Method	Description
static YamlEscaper.Option	valueOf(String name)	Returns the enum constant of this class with the specified name.
static YamlEscaper.Option[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ESCAPE_NON_ASCII

public static final YamlEscaper.Option ESCAPE_NON_ASCII

Escape characters above the ASCII range (i.e. ch > 0x7F). By default, only ASCII control characters and YAML specified characters are escaped. Specifying this option causes all ISO Latin-1, Unicode BMP and surrogate pair characters to be escaped.

Method Details

values

public static YamlEscaper.Option[] values()

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

Returns:

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

valueOf

public static YamlEscaper.Option valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null