Package com.levigo.jadice.server.documentplatform

Enum DocumentProcessor.ProcessingPhase

java.lang.Object

java.lang.Enum<DocumentProcessor.ProcessingPhase>

com.levigo.jadice.server.documentplatform.DocumentProcessor.ProcessingPhase

All Implemented Interfaces:

Serializable, Comparable<DocumentProcessor.ProcessingPhase>

Enclosing interface:

DocumentProcessor

public static enum DocumentProcessor.ProcessingPhase
extends Enum<DocumentProcessor.ProcessingPhase>

The different processing phases of the reshaping process in which the DocumentProcessor will be called.

Enum Constant Summary

Enum Constants

Enum Constant	Description
POST_READING	The Document was read successfully
PRE_READING	A new Reader has been created and configured, but no reading action has taken place so far; the given Document is empty.
PRE_RENDERING	The Document was pre-processed successfully and is just before the reshaping (rendering) processing phase

Method Summary

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

PRE_READING

public static final DocumentProcessor.ProcessingPhase PRE_READING

A new Reader has been created and configured, but no reading action has taken place so far; the given Document is empty.

POST_READING

public static final DocumentProcessor.ProcessingPhase POST_READING

The Document was read successfully

PRE_RENDERING

public static final DocumentProcessor.ProcessingPhase PRE_RENDERING

The Document was pre-processed successfully and is just before the reshaping (rendering) processing phase

Method Detail

values

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

Returns:

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

valueOf

public static DocumentProcessor.ProcessingPhase 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