Enum Class Backend

java.lang.Object

java.lang.Enum<Backend>

network.ike.docs.plugin.Backend

All Implemented Interfaces:

Serializable, Comparable<Backend>, Constable

public enum Backend
extends Enum<Backend>

AsciiDoc output backends supported by the AsciidocMojo.

Each backend maps to an AsciidoctorJ backend name and a default output subdirectory under the goal's outputDirectory.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCBOOK	DocBook 5 — intermediate XML for XEP/FOP XSL-FO pipelines.
HTML	HTML5 — website and CSS-to-PDF renderer input.
PDF	Prawn PDF — direct AsciiDoc-to-PDF via JRuby.

Method Summary

Modifier and Type	Method	Description
String	asciidoctorName()	The backend name as AsciidoctorJ expects it.
String	outputSubdir()	Default output subdirectory under the goal's output root.
static Backend	parse(String name)	Parse a backend name (case-insensitive).
boolean	supportsPostprocessor()	Whether this backend supports AsciidoctorJ Postprocessor extensions.
static Backend	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Backend[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HTML

public static final Backend HTML

HTML5 — website and CSS-to-PDF renderer input.

PDF

public static final Backend PDF

Prawn PDF — direct AsciiDoc-to-PDF via JRuby.

DOCBOOK

public static final Backend DOCBOOK

DocBook 5 — intermediate XML for XEP/FOP XSL-FO pipelines.

Method Details

values

public static Backend[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Backend valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

asciidoctorName

public String asciidoctorName()

The backend name as AsciidoctorJ expects it.

Returns:

the AsciidoctorJ backend identifier (e.g., "html5", "pdf", "docbook5")

outputSubdir

public String outputSubdir()

Default output subdirectory under the goal's output root.

Returns:

subdirectory name (e.g., "html", "pdf-prawn", "docbook")

supportsPostprocessor

public boolean supportsPostprocessor()

Whether this backend supports AsciidoctorJ Postprocessor extensions. The Prawn PDF backend crashes when a Java Postprocessor is registered (JRuby type conversion error in PostprocessorProxy).

Returns:

true if postprocessors can be safely registered

parse

public static Backend parse(String name)

Parse a backend name (case-insensitive).

Parameters:

name - one of: html, pdf, prawn, docbook

Returns:

the matching backend

Throws:

IllegalArgumentException - if name is not recognized