org.rythmengine

Enum RythmEngine.OutputMode

java.lang.Object

java.lang.Enum<RythmEngine.OutputMode>

org.rythmengine.RythmEngine.OutputMode

All Implemented Interfaces:

Serializable, Comparable<RythmEngine.OutputMode>

Enclosing class:

RythmEngine

public static enum RythmEngine.OutputMode
extends Enum<RythmEngine.OutputMode>

Defines the output method for render result.

• os: output to binary OutputStream
• writer: output to character based Writer
• str: return render result as a String

This is not an API used in user application

Enum Constant Summary

Enum Constants

Enum Constant and Description
os
str
writer

Method Summary

Modifier and Type	Method and Description
static RythmEngine.OutputMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RythmEngine.OutputMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
boolean	writeOutput() Return true if the current output mode is to output to OutputStream or Writer

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

os

public static final RythmEngine.OutputMode os

writer

public static final RythmEngine.OutputMode writer

str

public static final RythmEngine.OutputMode str

Method Detail

values

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

Returns:

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

valueOf

public static RythmEngine.OutputMode 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

writeOutput

public boolean writeOutput()

Return true if the current output mode is to output to OutputStream or Writer

Returns:

true if output mode is not return string