org.asciidoctor

Class Options

java.lang.Object

org.asciidoctor.Options

public class Options
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTES
static java.lang.String	BACKEND
static java.lang.String	BASEDIR
static java.lang.String	COMPACT
static java.lang.String	DESTINATION_DIR
static java.lang.String	DOCTYPE
static java.lang.String	ERUBY
static java.lang.String	HEADER_FOOTER
static java.lang.String	IN_PLACE
static java.lang.String	MKDIRS
static java.lang.String	PARSE_HEADER_ONLY
static java.lang.String	SAFE
static java.lang.String	SOURCE
static java.lang.String	TEMPLATE_CACHE
static java.lang.String	TEMPLATE_DIRS
static java.lang.String	TEMPLATE_ENGINE
static java.lang.String	TO_DIR
static java.lang.String	TO_FILE

Constructor Summary

Constructors

Constructor and Description
Options()
Options(java.util.Map<java.lang.String,java.lang.Object> options)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	map()
void	setAttributes(Attributes attributes)
void	setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	setBackend(java.lang.String backend)
void	setBaseDir(java.lang.String baseDir)
void	setCompact(boolean compact)
void	setDestinationDir(java.lang.String destinationDir)
void	setDocType(java.lang.String docType)
void	setEruby(java.lang.String eruby)
void	setHeaderFooter(boolean headerFooter) Toggle including header and footer into the output.
void	setInPlace(boolean inPlace)
void	setMkDirs(boolean mkDirs)
void	setOption(java.lang.String optionName, java.lang.Object optionValue)
void	setParseHeaderOnly(boolean parseHeaderOnly)
void	setSafe(SafeMode safeMode) Safe method calls safeMode.getLevel() to put the required level.
void	setTemplateCache(boolean templateCache)
void	setTemplateDirs(java.lang.String... templateDirs)
void	setTemplateEngine(java.lang.String templateEngine)
void	setToDir(java.lang.String toDir)
void	setToFile(boolean toFile) Toogle writing output to a file.
void	setToFile(java.lang.String toFile) Enable writing output to a file.
void	setToStream(java.io.OutputStream toStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IN_PLACE

public static final java.lang.String IN_PLACE

See Also:

Constant Field Values

ATTRIBUTES

public static final java.lang.String ATTRIBUTES

See Also:

Constant Field Values

HEADER_FOOTER

public static final java.lang.String HEADER_FOOTER

See Also:

Constant Field Values

TEMPLATE_DIRS

public static final java.lang.String TEMPLATE_DIRS

See Also:

Constant Field Values

TEMPLATE_ENGINE

public static final java.lang.String TEMPLATE_ENGINE

See Also:

Constant Field Values

TO_FILE

public static final java.lang.String TO_FILE

See Also:

Constant Field Values

TO_DIR

public static final java.lang.String TO_DIR

See Also:

Constant Field Values

MKDIRS

public static final java.lang.String MKDIRS

See Also:

Constant Field Values

SAFE

public static final java.lang.String SAFE

See Also:

Constant Field Values

ERUBY

public static final java.lang.String ERUBY

See Also:

Constant Field Values

COMPACT

public static final java.lang.String COMPACT

See Also:

Constant Field Values

DESTINATION_DIR

public static final java.lang.String DESTINATION_DIR

See Also:

Constant Field Values

BACKEND

public static final java.lang.String BACKEND

See Also:

Constant Field Values

DOCTYPE

public static final java.lang.String DOCTYPE

See Also:

Constant Field Values

BASEDIR

public static final java.lang.String BASEDIR

See Also:

Constant Field Values

TEMPLATE_CACHE

public static final java.lang.String TEMPLATE_CACHE

See Also:

Constant Field Values

SOURCE

public static final java.lang.String SOURCE

See Also:

Constant Field Values

PARSE_HEADER_ONLY

public static final java.lang.String PARSE_HEADER_ONLY

See Also:

Constant Field Values

Constructor Detail

Options

public Options()

Options

public Options(java.util.Map<java.lang.String,java.lang.Object> options)

Method Detail

setInPlace

public void setInPlace(boolean inPlace)

setAttributes

public void setAttributes(Attributes attributes)

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

setHeaderFooter

public void setHeaderFooter(boolean headerFooter)

Toggle including header and footer into the output.

Parameters:

headerFooter - If true, include header and footer into the output, otherwise exclude them. This overrides any output-specific defaults.

setTemplateDirs

public void setTemplateDirs(java.lang.String... templateDirs)

setTemplateEngine

public void setTemplateEngine(java.lang.String templateEngine)

setToFile

public void setToFile(java.lang.String toFile)

Enable writing output to a file. The file includes header and footer by default.

Parameters:

toFile - The path to the output file. If the path is not absolute, it is interpreted relative to what was set via #setToDir() or #setBaseDir(), in that order.

setToStream

public void setToStream(java.io.OutputStream toStream)

setToFile

public void setToFile(boolean toFile)

Toogle writing output to a file.

Parameters:

toFile - If true, write output to a file in the same directory as the input file, including header and footer into the output. If false, return output as a string without any header or footer. The default header and footer visibility can be overridden using #setHeaderFooter().

setToDir

public void setToDir(java.lang.String toDir)

setMkDirs

public void setMkDirs(boolean mkDirs)

setSafe

public void setSafe(SafeMode safeMode)

Safe method calls safeMode.getLevel() to put the required level.

Parameters:

safeMode - enum.

setEruby

public void setEruby(java.lang.String eruby)

setCompact

public void setCompact(boolean compact)

setDestinationDir

public void setDestinationDir(java.lang.String destinationDir)

setBackend

public void setBackend(java.lang.String backend)

setDocType

public void setDocType(java.lang.String docType)

setBaseDir

public void setBaseDir(java.lang.String baseDir)

setTemplateCache

public void setTemplateCache(boolean templateCache)

setParseHeaderOnly

public void setParseHeaderOnly(boolean parseHeaderOnly)

setOption

public void setOption(java.lang.String optionName,
                      java.lang.Object optionValue)

map

public java.util.Map<java.lang.String,java.lang.Object> map()