rasmus_torkel.text.encode

Enum SpaceEscapeOption

java.lang.Object

java.lang.Enum<SpaceEscapeOption>

rasmus_torkel.text.encode.SpaceEscapeOption

All Implemented Interfaces:

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

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

Having non-simple white spaces, in particular anything that causes line break, can make some data-format look messy and completely invalidate others. That's why we need the ability to specify escaping of non-simple spaces, even if such characters are otherwise not special.

Also, non-simple white spaces may, depending on the data format, be escaped differently, for example '\n' for line feed instead of unicode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DONT_ESCAPE
ESCAPE_NON_SIMPLE

Method Summary

Methods

Modifier and Type	Method and Description
static SpaceEscapeOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SpaceEscapeOption[]	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

DONT_ESCAPE

public static final SpaceEscapeOption DONT_ESCAPE

ESCAPE_NON_SIMPLE

public static final SpaceEscapeOption ESCAPE_NON_SIMPLE

Method Detail

values

public static SpaceEscapeOption[] 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 (SpaceEscapeOption c : SpaceEscapeOption.values())
    System.out.println(c);

Returns:

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

valueOf

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