de.innovationgate.wgpublisher.encoders

Enum TextChunk.Origin

java.lang.Object

java.lang.Enum<TextChunk.Origin>

de.innovationgate.wgpublisher.encoders.TextChunk.Origin

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TextChunk.Origin>

Enclosing class:

TextChunk

public static enum TextChunk.Origin
extends java.lang.Enum<TextChunk.Origin>

An enum denoting the origin of a text chunk, which often decides if an encoder will transform or ignore it

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDED Added by a WGA encoder.
INPUT Generic input string, fully encodeable.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INPUT

public static final TextChunk.Origin INPUT

Generic input string, fully encodeable. Maybe transformed by an earlier encoder.

ADDED

public static final TextChunk.Origin ADDED

Added by a WGA encoder. Most encoders add chunks of this origin so they won't be modified by later encoders.

Method Detail

values

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

Returns:

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

valueOf

public static TextChunk.Origin 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