uk.ac.ed.ph.snuggletex.definitions

Enum TextFlowContext

java.lang.Object

java.lang.Enum<TextFlowContext>

uk.ac.ed.ph.snuggletex.definitions.TextFlowContext

All Implemented Interfaces:

Serializable, Comparable<TextFlowContext>

public enum TextFlowContext
extends Enum<TextFlowContext>

This enumeration specifies how text-based FlowTokens should be handled when being merged into the resulting XHTML DOM.

Version:

$Revision:179 $

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_INLINE This token is allowed in inline XHTML
IGNORE This token makes no output and can be used anywhere
START_NEW_XHTML_BLOCK This token will start a new XHTML Block

Method Summary

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

START_NEW_XHTML_BLOCK

public static final TextFlowContext START_NEW_XHTML_BLOCK

This token will start a new XHTML Block

ALLOW_INLINE

public static final TextFlowContext ALLOW_INLINE

This token is allowed in inline XHTML

IGNORE

public static final TextFlowContext IGNORE

This token makes no output and can be used anywhere

Method Detail

values

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

Returns:

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

valueOf

public static TextFlowContext 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 name

NullPointerException - if the argument is null