org.asciidoctor

Interface Asciidoctor

All Known Implementing Classes:

JRubyAsciidoctor

public interface Asciidoctor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Asciidoctor.Factory Factory for creating a new instance of Asciidoctor interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STRUCTURE_MAX_LEVEL

Method Summary

Modifier and Type	Method and Description
java.lang.String	asciidoctorVersion() Method that gets the asciidoctor version which is being used..
void	convert(java.io.Reader contentReader, java.io.Writer rendererWriter, java.util.Map<java.lang.String,java.lang.Object> options) Parse the document read from reader, and rendered result is sent to writer.
void	convert(java.io.Reader contentReader, java.io.Writer rendererWriter, Options options) Parse the document read from reader, and rendered result is sent to writer.
void	convert(java.io.Reader contentReader, java.io.Writer rendererWriter, OptionsBuilder options) Parse the document read from reader, and rendered result is sent to writer.
java.lang.String	convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
<T> T	convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Class<T> expectedResult) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
java.lang.String	convert(java.lang.String content, Options options) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
java.lang.String	convert(java.lang.String content, OptionsBuilder options) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
<T> T	convert(java.lang.String content, OptionsBuilder options, java.lang.Class<T> expectedResult) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
<T> T	convert(java.lang.String content, Options options, java.lang.Class<T> expectedResult) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
java.lang.String[]	convertDirectory(DirectoryWalker directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options) Parse all AsciiDoc files found using DirectoryWalker instance.
java.lang.String[]	convertDirectory(DirectoryWalker directoryWalker, Options options) Parse all AsciiDoc files found using DirectoryWalker instance.
java.lang.String[]	convertDirectory(DirectoryWalker directoryWalker, OptionsBuilder options) Parse all AsciiDoc files found using DirectoryWalker instance.
java.lang.String	convertFile(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
<T> T	convertFile(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Class<T> expectedResult) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
java.lang.String	convertFile(java.io.File filename, Options options) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
java.lang.String	convertFile(java.io.File filename, OptionsBuilder options) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
<T> T	convertFile(java.io.File filename, OptionsBuilder options, java.lang.Class<T> expectedResult) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
<T> T	convertFile(java.io.File filename, Options options, java.lang.Class<T> expectedResult) Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.
java.lang.String[]	convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options) Parses all files added inside a collection.
java.lang.String[]	convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, Options options) Parses all files added inside a collection.
java.lang.String[]	convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, OptionsBuilder options) Parses all files added inside a collection.
ExtensionGroup	createGroup() Creates an ExtensionGroup that can be used to register and unregister a group of extensions.
ExtensionGroup	createGroup(java.lang.String groupName) Creates an ExtensionGroup that can be used to register and unregister a group of extensions.
JavaConverterRegistry	javaConverterRegistry() Creates a registry for registering converters.
JavaExtensionRegistry	javaExtensionRegistry() Creates an extension registry ready to be used for registering all processors
Document	load(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options) Loads AsciiDoc content and returns the Document object.
Document	loadFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options) Loads AsciiDoc content from file and returns the Document object.
DocumentHeader	readDocumentHeader(java.io.File filename) Reads only header parameters instead of all document.
DocumentHeader	readDocumentHeader(java.io.Reader contentReader) Reads only header parameters instead of all document.
DocumentHeader	readDocumentHeader(java.lang.String content) Reads only header parameters instead of all document.
void	registerLogHandler(LogHandler logHandler)
void	render(java.io.Reader contentReader, java.io.Writer rendererWriter, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Will be removed in the next major version (2.0.0). Please use convert(Reader, Writer, Map).
void	render(java.io.Reader contentReader, java.io.Writer rendererWriter, Options options) Deprecated. Will be removed in the next major version (2.0.0). Please use convert(Reader, Writer, Map).
void	render(java.io.Reader contentReader, java.io.Writer rendererWriter, OptionsBuilder options) Deprecated. Will be removed in the next major version (2.0.0). Please use convert(Reader, Writer, OptionsBuilder).
java.lang.String	render(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Will be removed in the next major version (2.0.0). Please use convert(String, Map).
java.lang.String	render(java.lang.String content, Options options) Deprecated. Will be removed in the next major version (2.0.0). Please use convert(String, Options).
java.lang.String	render(java.lang.String content, OptionsBuilder options) Deprecated. Will be removed in the next major version (2.0.0). Please use convert(String, OptionsBuilder).
java.lang.String[]	renderDirectory(DirectoryWalker directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertDirectory(DirectoryWalker, Map).
java.lang.String[]	renderDirectory(DirectoryWalker directoryWalker, Options options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertDirectory(DirectoryWalker, Options).
java.lang.String[]	renderDirectory(DirectoryWalker directoryWalker, OptionsBuilder options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertDirectory(DirectoryWalker, OptionsBuilder).
java.lang.String	renderFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertFile(File, Map).
java.lang.String	renderFile(java.io.File file, Options options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertFile(File, Options).
java.lang.String	renderFile(java.io.File file, OptionsBuilder options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertFile(File, OptionsBuilder).
java.lang.String[]	renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertFiles(Collection, Map).
java.lang.String[]	renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, Options options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertFiles(Collection, Options).
java.lang.String[]	renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, OptionsBuilder options) Deprecated. Will be removed in the next major version (2.0.0). Please use convertFiles(Collection, OptionsBuilder).
void	requireLibraries(java.util.Collection<java.lang.String> requiredLibraries) Require the given Ruby libraries by name when rendering.
void	requireLibrary(java.lang.String... requiredLibraries) Require the given Ruby libraries by name when rendering.
RubyExtensionRegistry	rubyExtensionRegistry() Creates an Ruby extension registry ready to be used for registering all processors
void	shutdown() This method frees all resources consumed by asciidoctorJ module.
void	unregisterAllExtensions() Unregister all registered extensions.
void	unregisterLogHandler(LogHandler logHandler)

Field Detail

STRUCTURE_MAX_LEVEL

static final java.lang.String STRUCTURE_MAX_LEVEL

See Also:

Constant Field Values

Method Detail

render

@Deprecated
java.lang.String render(java.lang.String content,
                                    java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convert(String, Map).

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

Returns:

the rendered output String is returned

Since:

1.6.0

render

@Deprecated
java.lang.String render(java.lang.String content,
                                    Options options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convert(String, Options).

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

Returns:

the rendered output String is returned

Since:

1.6.0

render

@Deprecated
java.lang.String render(java.lang.String content,
                                    OptionsBuilder options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convert(String, OptionsBuilder).

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

Returns:

the rendered output String is returned

Since:

1.6.0

render

@Deprecated
void render(java.io.Reader contentReader,
                        java.io.Writer rendererWriter,
                        java.util.Map<java.lang.String,java.lang.Object> options)
                 throws java.io.IOException

Deprecated. Will be removed in the next major version (2.0.0). Please use convert(Reader, Writer, Map).

Parse the document read from reader, and rendered result is sent to writer.

Parameters:

contentReader - where asciidoc content is read.

rendererWriter - where rendered content is written. Writer is flushed, but not closed.

options - a Hash of options to control processing (default: {}).

Throws:

java.io.IOException - if an error occurs while writing rendered content, this exception is thrown.

Since:

1.6.0

render

@Deprecated
void render(java.io.Reader contentReader,
                        java.io.Writer rendererWriter,
                        Options options)
                 throws java.io.IOException

Deprecated. Will be removed in the next major version (2.0.0). Please use convert(Reader, Writer, Map).

Parse the document read from reader, and rendered result is sent to writer.

Parameters:

contentReader - where asciidoc content is read.

rendererWriter - where rendered content is written. Writer is flushed, but not closed.

options - a Hash of options to control processing (default: {}).

Throws:

java.io.IOException - if an error occurs while writing rendered content, this exception is thrown.

Since:

1.6.0

render

@Deprecated
void render(java.io.Reader contentReader,
                        java.io.Writer rendererWriter,
                        OptionsBuilder options)
                 throws java.io.IOException

Deprecated. Will be removed in the next major version (2.0.0). Please use convert(Reader, Writer, OptionsBuilder).

Parse the document read from reader, and rendered result is sent to writer.

Parameters:

contentReader - where asciidoc content is read.

rendererWriter - where rendered content is written. Writer is flushed, but not closed.

options - a Hash of options to control processing (default: {}).

Throws:

java.io.IOException - if an error occurs while writing rendered content, this exception is thrown.

Since:

1.6.0

renderFile

@Deprecated
java.lang.String renderFile(java.io.File file,
                                        java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertFile(File, Map).

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

file - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

Returns:

returns nothing if the rendered output String is written to a file.

Since:

1.6.0

renderFile

@Deprecated
java.lang.String renderFile(java.io.File file,
                                        Options options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertFile(File, Options).

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

file - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

Returns:

returns nothing if the rendered output String is written to a file.

Since:

1.6.0

renderFile

@Deprecated
java.lang.String renderFile(java.io.File file,
                                        OptionsBuilder options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertFile(File, OptionsBuilder).

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

file - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

Returns:

returns nothing if the rendered output String is written to a file.

Since:

1.6.0

renderDirectory

@Deprecated
java.lang.String[] renderDirectory(DirectoryWalker directoryWalker,
                                               java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertDirectory(DirectoryWalker, Map).

Parse all AsciiDoc files found using DirectoryWalker instance.

Parameters:

directoryWalker - strategy used to retrieve all files to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

Since:

1.6.0

renderDirectory

@Deprecated
java.lang.String[] renderDirectory(DirectoryWalker directoryWalker,
                                               Options options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertDirectory(DirectoryWalker, Options).

Parse all AsciiDoc files found using DirectoryWalker instance.

Parameters:

directoryWalker - strategy used to retrieve all files to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

Since:

1.6.0

renderDirectory

@Deprecated
java.lang.String[] renderDirectory(DirectoryWalker directoryWalker,
                                               OptionsBuilder options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertDirectory(DirectoryWalker, OptionsBuilder).

Parse all AsciiDoc files found using DirectoryWalker instance.

Parameters:

directoryWalker - strategy used to retrieve all files to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

Since:

1.6.0

renderFiles

@Deprecated
java.lang.String[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles,
                                           java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertFiles(Collection, Map).

Parses all files added inside a collection.

Parameters:

asciidoctorFiles - to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

Since:

1.6.0

renderFiles

@Deprecated
java.lang.String[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles,
                                           Options options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertFiles(Collection, Options).

Parses all files added inside a collection.

Parameters:

asciidoctorFiles - to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

Since:

1.6.0

renderFiles

@Deprecated
java.lang.String[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles,
                                           OptionsBuilder options)

Deprecated. Will be removed in the next major version (2.0.0). Please use convertFiles(Collection, OptionsBuilder).

Parses all files added inside a collection.

Parameters:

asciidoctorFiles - to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

Since:

1.6.0

convert

java.lang.String convert(java.lang.String content,
                         java.util.Map<java.lang.String,java.lang.Object> options)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

Returns:

the rendered output String is returned

convert

<T> T convert(java.lang.String content,
              java.util.Map<java.lang.String,java.lang.Object> options,
              java.lang.Class<T> expectedResult)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

expectedResult - the expected return type. Usually String for HTML based formats. In this case convert(String, Map) is the same.

Returns:

the rendered output String is returned

convert

java.lang.String convert(java.lang.String content,
                         Options options)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

Returns:

the rendered output String is returned

convert

<T> T convert(java.lang.String content,
              Options options,
              java.lang.Class<T> expectedResult)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

expectedResult - the expected return type. Usually String for HTML based formats. In this case convert(String, Options) is the same.

Returns:

the rendered output String is returned

convert

java.lang.String convert(java.lang.String content,
                         OptionsBuilder options)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

Returns:

the rendered output String is returned

convert

<T> T convert(java.lang.String content,
              OptionsBuilder options,
              java.lang.Class<T> expectedResult)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as String object.

Parameters:

content - the AsciiDoc source as String.

options - a Hash of options to control processing (default: {}).

expectedResult - the expected return type. Usually String for HTML based formats. In this case convert(String, OptionsBuilder) is the same.

Returns:

the rendered output String is returned

convert

void convert(java.io.Reader contentReader,
             java.io.Writer rendererWriter,
             java.util.Map<java.lang.String,java.lang.Object> options)
      throws java.io.IOException

Parse the document read from reader, and rendered result is sent to writer.

Parameters:

contentReader - where asciidoc content is read.

rendererWriter - where rendered content is written. Writer is flushed, but not closed.

options - a Hash of options to control processing (default: {}).

Throws:

java.io.IOException - if an error occurs while writing rendered content, this exception is thrown.

convert

void convert(java.io.Reader contentReader,
             java.io.Writer rendererWriter,
             Options options)
      throws java.io.IOException

Parse the document read from reader, and rendered result is sent to writer.

Parameters:

contentReader - where asciidoc content is read.

rendererWriter - where rendered content is written. Writer is flushed, but not closed.

options - a Hash of options to control processing (default: {}).

Throws:

java.io.IOException - if an error occurs while writing rendered content, this exception is thrown.

convert

void convert(java.io.Reader contentReader,
             java.io.Writer rendererWriter,
             OptionsBuilder options)
      throws java.io.IOException

Parse the document read from reader, and rendered result is sent to writer.

Parameters:

contentReader - where asciidoc content is read.

rendererWriter - where rendered content is written. Writer is flushed, but not closed.

options - a Hash of options to control processing (default: {}).

Throws:

java.io.IOException - if an error occurs while writing rendered content, this exception is thrown.

convertFile

java.lang.String convertFile(java.io.File filename,
                             java.util.Map<java.lang.String,java.lang.Object> options)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

filename - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

Returns:

returns nothing if the rendered output String is written to a file.

convertFile

<T> T convertFile(java.io.File filename,
                  java.util.Map<java.lang.String,java.lang.Object> options,
                  java.lang.Class<T> expectedResult)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

filename - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

expectedResult - the expected return type. Usually String for HTML based formats. In this case convertFile(File, Map) is the same.

Returns:

returns nothing if the rendered output is written to a file.

convertFile

java.lang.String convertFile(java.io.File filename,
                             Options options)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

filename - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

Returns:

returns nothing if the rendered output String is written to a file.

convertFile

<T> T convertFile(java.io.File filename,
                  Options options,
                  java.lang.Class<T> expectedResult)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

filename - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

expectedResult - the expected return type. Usually String for HTML based formats. In this case convertFile(File, Map) is the same.

Returns:

returns nothing if the rendered output is written to a file.

convertFile

java.lang.String convertFile(java.io.File filename,
                             OptionsBuilder options)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

filename - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

Returns:

returns nothing if the rendered output String is written to a file.

convertFile

<T> T convertFile(java.io.File filename,
                  OptionsBuilder options,
                  java.lang.Class<T> expectedResult)

Parse the AsciiDoc source input into an Document Document and render it to the specified backend format.

Accepts input as File path.

If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

Parameters:

filename - an input Asciidoctor file.

options - a Hash of options to control processing (default: {}).

expectedResult - the expected return type. Usually String for HTML based formats. In this case convertFile(File, Map) is the same.

Returns:

returns nothing if the rendered output is written to a file.

convertDirectory

java.lang.String[] convertDirectory(DirectoryWalker directoryWalker,
                                    java.util.Map<java.lang.String,java.lang.Object> options)

Parse all AsciiDoc files found using DirectoryWalker instance.

Parameters:

directoryWalker - strategy used to retrieve all files to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

convertDirectory

java.lang.String[] convertDirectory(DirectoryWalker directoryWalker,
                                    Options options)

Parse all AsciiDoc files found using DirectoryWalker instance.

Parameters:

directoryWalker - strategy used to retrieve all files to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

convertDirectory

java.lang.String[] convertDirectory(DirectoryWalker directoryWalker,
                                    OptionsBuilder options)

Parse all AsciiDoc files found using DirectoryWalker instance.

Parameters:

directoryWalker - strategy used to retrieve all files to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

convertFiles

java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles,
                                java.util.Map<java.lang.String,java.lang.Object> options)

Parses all files added inside a collection.

Parameters:

asciidoctorFiles - to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

convertFiles

java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles,
                                Options options)

Parses all files added inside a collection.

Parameters:

asciidoctorFiles - to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

convertFiles

java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles,
                                OptionsBuilder options)

Parses all files added inside a collection.

Parameters:

asciidoctorFiles - to be rendered.

options - a Hash of options to control processing (default: {}).

Returns:

returns an array of 0 positions if the rendered output is written to a file.

readDocumentHeader

DocumentHeader readDocumentHeader(java.io.File filename)

Reads only header parameters instead of all document.

Parameters:

filename - to read the attributes.

Returns:

header.

readDocumentHeader

DocumentHeader readDocumentHeader(java.lang.String content)

Reads only header parameters instead of all document.

Parameters:

content - where rendered content is written. Writer is flushed, but not closed.

Returns:

header.

readDocumentHeader

DocumentHeader readDocumentHeader(java.io.Reader contentReader)

Reads only header parameters instead of all document.

Parameters:

contentReader - where asciidoc content is read.

Returns:

header.

requireLibrary

void requireLibrary(java.lang.String... requiredLibraries)

Require the given Ruby libraries by name when rendering.

Parameters:

requiredLibraries -

requireLibraries

void requireLibraries(java.util.Collection<java.lang.String> requiredLibraries)

Require the given Ruby libraries by name when rendering.

Parameters:

requiredLibraries -

javaExtensionRegistry

JavaExtensionRegistry javaExtensionRegistry()

Creates an extension registry ready to be used for registering all processors

Returns:

Extension Registry object.

rubyExtensionRegistry

RubyExtensionRegistry rubyExtensionRegistry()

Creates an Ruby extension registry ready to be used for registering all processors

Returns:

Extension Registry object.

javaConverterRegistry

JavaConverterRegistry javaConverterRegistry()

Creates a registry for registering converters.

Returns:

Converter Registry object.

createGroup

ExtensionGroup createGroup()

Creates an ExtensionGroup that can be used to register and unregister a group of extensions.

Returns:

createGroup

ExtensionGroup createGroup(java.lang.String groupName)

Creates an ExtensionGroup that can be used to register and unregister a group of extensions.

Returns:

unregisterAllExtensions

void unregisterAllExtensions()

Unregister all registered extensions.

shutdown

void shutdown()

This method frees all resources consumed by asciidoctorJ module. Keep in mind that if this method is called, instance becomes unusable and you should create another instance.

asciidoctorVersion

java.lang.String asciidoctorVersion()

Method that gets the asciidoctor version which is being used..

Returns:

Version number.

load

Document load(java.lang.String content,
              java.util.Map<java.lang.String,java.lang.Object> options)

Loads AsciiDoc content and returns the Document object.

Parameters:

content - to be parsed.

options -

Returns:

Document of given content.

loadFile

Document loadFile(java.io.File file,
                  java.util.Map<java.lang.String,java.lang.Object> options)

Loads AsciiDoc content from file and returns the Document object.

Parameters:

file - to be loaded.

options -

Returns:

Document of given content.

registerLogHandler

void registerLogHandler(LogHandler logHandler)

unregisterLogHandler

void unregisterLogHandler(LogHandler logHandler)