org.forgerock.doc.maven

Enum AbstractDocbkxMojo.Format

java.lang.Object

java.lang.Enum<AbstractDocbkxMojo.Format>

org.forgerock.doc.maven.AbstractDocbkxMojo.Format

All Implemented Interfaces:

Serializable, Comparable<AbstractDocbkxMojo.Format>

Enclosing class:

AbstractDocbkxMojo

public static enum AbstractDocbkxMojo.Format
extends Enum<AbstractDocbkxMojo.Format>

Supported output formats.

Enum Constant Summary

Enum Constants

Enum Constant and Description
bootstrap Styled with HtmlForBootstrap single-page HTML 4.
epub EPUB v2 without styling; not ready for publication.
html Styled single-page and chunked HTML 4.
man Reference manual pages for use with the man command.
pdf PDF.
rtf RTF without styling; not ready for publication.
webhelp Styled DocBook Webhelp format.
xhtml5 Single-page XHTML5 without styling except syntax highlighting; not ready for publication as is.

Method Summary

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

epub

public static final AbstractDocbkxMojo.Format epub

EPUB v2 without styling; not ready for publication.

html

public static final AbstractDocbkxMojo.Format html

Styled single-page and chunked HTML 4.

bootstrap

public static final AbstractDocbkxMojo.Format bootstrap

Styled with HtmlForBootstrap single-page HTML 4.

man

public static final AbstractDocbkxMojo.Format man

Reference manual pages for use with the man command.

pdf

public static final AbstractDocbkxMojo.Format pdf

PDF.

rtf

public static final AbstractDocbkxMojo.Format rtf

RTF without styling; not ready for publication.

webhelp

public static final AbstractDocbkxMojo.Format webhelp

Styled DocBook Webhelp format.

xhtml5

public static final AbstractDocbkxMojo.Format xhtml5

Single-page XHTML5 without styling except syntax highlighting; not ready for publication as is.

Method Detail

values

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

Returns:

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

valueOf

public static AbstractDocbkxMojo.Format 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