org.asciidoctor

Interface Asciidoctor

All Known Implementing Classes:

JRubyAsciidoctor

public interface Asciidoctor

Author:

lordofthejars

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 String	STRUCTURE_MAX_LEVEL

Method Summary

Methods

Modifier and Type	Method and Description
String	asciidoctorVersion() Method that gets the asciidoctor version which is being used..
void	convert(Reader contentReader, Writer rendererWriter, Map<String,Object> options) Parse the document read from reader, and rendered result is sent to writer.
void	convert(Reader contentReader, Writer rendererWriter, Options options) Parse the document read from reader, and rendered result is sent to writer.
void	convert(Reader contentReader, Writer rendererWriter, OptionsBuilder options) Parse the document read from reader, and rendered result is sent to writer.
String	convert(String content, Map<String,Object> options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	convert(String content, Options options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	convert(String content, OptionsBuilder options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String[]	convertDirectory(DirectoryWalker directoryWalker, Map<String,Object> options) Parse all AsciiDoc files found using DirectoryWalker instance.
String[]	convertDirectory(DirectoryWalker directoryWalker, Options options) Parse all AsciiDoc files found using DirectoryWalker instance.
String[]	convertDirectory(DirectoryWalker directoryWalker, OptionsBuilder options) Parse all AsciiDoc files found using DirectoryWalker instance.
String	convertFile(File filename, Map<String,Object> options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	convertFile(File filename, Options options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	convertFile(File filename, OptionsBuilder options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String[]	convertFiles(Collection<File> asciidoctorFiles, Map<String,Object> options) Parses all files added inside a collection.
String[]	convertFiles(Collection<File> asciidoctorFiles, Options options) Parses all files added inside a collection.
String[]	convertFiles(Collection<File> asciidoctorFiles, OptionsBuilder options) Parses all files added inside a collection.
JavaExtensionRegistry	javaExtensionRegistry() Creates an extension registry ready to be used for registering all processors
Document	load(String content, Map<String,Object> options) Loads AsciiDoc content and returns the Document object.
Document	loadFile(File file, Map<String,Object> options) Loads AsciiDoc content from file and returns the Document object.
DocumentHeader	readDocumentHeader(File filename) Reads only header parameters instead of all document.
DocumentHeader	readDocumentHeader(Reader contentReader) Reads only header parameters instead of all document.
DocumentHeader	readDocumentHeader(String content) Reads only header parameters instead of all document.
StructuredDocument	readDocumentStructure(File filename, Map<String,Object> options) Reads and creates structured document containing header and content chunks.
StructuredDocument	readDocumentStructure(Reader contentReader, Map<String,Object> options) Reads and creates structured document containing header and content chunks.
StructuredDocument	readDocumentStructure(String content, Map<String,Object> options) Reads and creates structured document containing header and content chunks.
void	render(Reader contentReader, Writer rendererWriter, Map<String,Object> options) Parse the document read from reader, and rendered result is sent to writer.
void	render(Reader contentReader, Writer rendererWriter, Options options) Parse the document read from reader, and rendered result is sent to writer.
void	render(Reader contentReader, Writer rendererWriter, OptionsBuilder options) Parse the document read from reader, and rendered result is sent to writer.
String	render(String content, Map<String,Object> options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	render(String content, Options options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	render(String content, OptionsBuilder options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String[]	renderDirectory(DirectoryWalker directoryWalker, Map<String,Object> options) Parse all AsciiDoc files found using DirectoryWalker instance.
String[]	renderDirectory(DirectoryWalker directoryWalker, Options options) Parse all AsciiDoc files found using DirectoryWalker instance.
String[]	renderDirectory(DirectoryWalker directoryWalker, OptionsBuilder options) Parse all AsciiDoc files found using DirectoryWalker instance.
String	renderFile(File filename, Map<String,Object> options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	renderFile(File filename, Options options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String	renderFile(File filename, OptionsBuilder options) Parse the AsciiDoc source input into an Document DocumentRuby and render it to the specified backend format.
String[]	renderFiles(Collection<File> asciidoctorFiles, Map<String,Object> options) Parses all files added inside a collection.
String[]	renderFiles(Collection<File> asciidoctorFiles, Options options) Parses all files added inside a collection.
String[]	renderFiles(Collection<File> asciidoctorFiles, OptionsBuilder options) Parses all files added inside a collection.
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.

Field Detail

STRUCTURE_MAX_LEVEL

static final String STRUCTURE_MAX_LEVEL

See Also:

Constant Field Values

Method Detail

render

String render(String content,
            Map<String,Object> options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

render

String render(String content,
            Options options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

render

String render(String content,
            OptionsBuilder options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

render

void render(Reader contentReader,
          Writer rendererWriter,
          Map<String,Object> options)
            throws 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:

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

render

void render(Reader contentReader,
          Writer rendererWriter,
          Options options)
            throws 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:

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

render

void render(Reader contentReader,
          Writer rendererWriter,
          OptionsBuilder options)
            throws 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:

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

renderFile

String renderFile(File filename,
                Map<String,Object> options)

Parse the AsciiDoc source input into an Document DocumentRuby 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.

renderFile

String renderFile(File filename,
                Options options)

Parse the AsciiDoc source input into an Document DocumentRuby 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.

renderFile

String renderFile(File filename,
                OptionsBuilder options)

Parse the AsciiDoc source input into an Document DocumentRuby 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.

renderDirectory

String[] renderDirectory(DirectoryWalker directoryWalker,
                       Map<String,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.

renderDirectory

String[] renderDirectory(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.

renderDirectory

String[] renderDirectory(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.

renderFiles

String[] renderFiles(Collection<File> asciidoctorFiles,
                   Map<String,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.

renderFiles

String[] renderFiles(Collection<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.

renderFiles

String[] renderFiles(Collection<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.

convert

String convert(String content,
             Map<String,Object> options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

String convert(String content,
             Options options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

String convert(String content,
             OptionsBuilder options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

void convert(Reader contentReader,
           Writer rendererWriter,
           Map<String,Object> options)
             throws 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:

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

convert

void convert(Reader contentReader,
           Writer rendererWriter,
           Options options)
             throws 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:

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

convert

void convert(Reader contentReader,
           Writer rendererWriter,
           OptionsBuilder options)
             throws 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:

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

convertFile

String convertFile(File filename,
                 Map<String,Object> options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

String convertFile(File filename,
                 Options options)

Parse the AsciiDoc source input into an Document DocumentRuby 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

String convertFile(File filename,
                 OptionsBuilder options)

Parse the AsciiDoc source input into an Document DocumentRuby 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.

convertDirectory

String[] convertDirectory(DirectoryWalker directoryWalker,
                        Map<String,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

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

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

String[] convertFiles(Collection<File> asciidoctorFiles,
                    Map<String,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

String[] convertFiles(Collection<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

String[] convertFiles(Collection<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.

readDocumentStructure

StructuredDocument readDocumentStructure(File filename,
                                       Map<String,Object> options)

Reads and creates structured document containing header and content chunks. By default it dig only one level down but it can be tweak by setting STRUCTURE_MAX_LEVEL option.

Parameters:

filename - to read the attributes.

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

Returns:

structured document.

readDocumentStructure

StructuredDocument readDocumentStructure(String content,
                                       Map<String,Object> options)

Reads and creates structured document containing header and content chunks. By default it dig only one level down but it can be tweak by setting STRUCTURE_MAX_LEVEL option.

Parameters:

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

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

Returns:

structured document.

readDocumentStructure

StructuredDocument readDocumentStructure(Reader contentReader,
                                       Map<String,Object> options)

Reads and creates structured document containing header and content chunks. By default it dig only one level down but it can be tweak by setting STRUCTURE_MAX_LEVEL option.

Parameters:

contentReader - where asciidoc content is read.

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

Returns:

structured document.

readDocumentHeader

DocumentHeader readDocumentHeader(File filename)

Reads only header parameters instead of all document.

Parameters:

filename - to read the attributes.

Returns:

header.

readDocumentHeader

DocumentHeader readDocumentHeader(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(Reader contentReader)

Reads only header parameters instead of all document.

Parameters:

contentReader - where asciidoc content is read.

Returns:

header.

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.

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

String asciidoctorVersion()

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

Returns:

Version number.

load

Document load(String content,
            Map<String,Object> options)

Loads AsciiDoc content and returns the Document object.

Parameters:

content - to be parsed.

options -

Returns:

Document of given content.

loadFile

Document loadFile(File file,
                Map<String,Object> options)

Loads AsciiDoc content from file and returns the Document object.

Parameters:

file - to be loaded.

options -

Returns:

Document of given content.