com.io7m.kstructural.frontend

Enum KSOpCompileXHTML.XHTMLPagination

java.lang.Object

java.lang.Enum<KSOpCompileXHTML.XHTMLPagination>

com.io7m.kstructural.frontend.KSOpCompileXHTML.XHTMLPagination

All Implemented Interfaces:

Serializable, Comparable<KSOpCompileXHTML.XHTMLPagination>

Enclosing class:

KSOpCompileXHTML

public static enum KSOpCompileXHTML.XHTMLPagination
extends Enum<KSOpCompileXHTML.XHTMLPagination>

The type of XHTML pagination.

Enum Constant Summary

Enum Constants

Enum Constant and Description
XHTML_MULTI_PAGE The output will be written to multiple XHTML pages, one page per document, section, and part.
XHTML_SINGLE_PAGE The output will be a single XHTML page.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XHTML_SINGLE_PAGE

public static final KSOpCompileXHTML.XHTMLPagination XHTML_SINGLE_PAGE

The output will be a single XHTML page.

XHTML_MULTI_PAGE

public static final KSOpCompileXHTML.XHTMLPagination XHTML_MULTI_PAGE

The output will be written to multiple XHTML pages, one page per document, section, and part.

Method Detail

values

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

Returns:

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

valueOf

public static KSOpCompileXHTML.XHTMLPagination 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

toString

public String toString()

Overrides:

toString in class Enum<KSOpCompileXHTML.XHTMLPagination>

getName

public String getName()

Returns:

The pagination type name