uk.ac.ed.ph.snuggletex

Enum SnuggleSession.EndOutputAction

java.lang.Object

java.lang.Enum<SnuggleSession.EndOutputAction>

uk.ac.ed.ph.snuggletex.SnuggleSession.EndOutputAction

All Implemented Interfaces:

Serializable, Comparable<SnuggleSession.EndOutputAction>

Enclosing class:

SnuggleSession

public static enum SnuggleSession.EndOutputAction
extends Enum<SnuggleSession.EndOutputAction>

Trivial enumeration which specifies the possible actions to perform once we finish writing with the various SnuggleSession.writeWebPage(WebPageOutputOptions, OutputStream) methods.

Since:

1.2.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE Closes the OutputStream after writing
DO_NOTHING Does nothing after writing
FLUSH Flushes the OutputStream after writing

Method Summary

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

CLOSE

public static final SnuggleSession.EndOutputAction CLOSE

Closes the OutputStream after writing

FLUSH

public static final SnuggleSession.EndOutputAction FLUSH

Flushes the OutputStream after writing

DO_NOTHING

public static final SnuggleSession.EndOutputAction DO_NOTHING

Does nothing after writing

Method Detail

values

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

Returns:

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

valueOf

public static SnuggleSession.EndOutputAction 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