org.asciidoctor.internal

Class JRubyAsciidoctor

java.lang.Object

org.asciidoctor.internal.JRubyAsciidoctor

All Implemented Interfaces:

Asciidoctor

public class JRubyAsciidoctor
extends java.lang.Object
implements Asciidoctor

Nested Class Summary

Nested classes/interfaces inherited from interface org.asciidoctor.Asciidoctor

Asciidoctor.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected RubyGemsPreloader	rubyGemsPreloader
protected org.jruby.Ruby	rubyRuntime

Fields inherited from interface org.asciidoctor.Asciidoctor

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.
static JRubyAsciidoctor	create()
static JRubyAsciidoctor	create(java.lang.ClassLoader classloader)
static JRubyAsciidoctor	create(java.lang.ClassLoader classloader, java.lang.String gemPath)
static JRubyAsciidoctor	create(java.util.List<java.lang.String> loadPaths)
static JRubyAsciidoctor	create(java.util.List<java.lang.String> loadPaths, java.lang.String gemPath)
static JRubyAsciidoctor	create(java.lang.String gemPath)
org.jruby.Ruby	getRubyRuntime()
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.
StructuredDocument	readDocumentStructure(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options) Reads and creates structured document containing header and content chunks.
StructuredDocument	readDocumentStructure(java.io.Reader contentReader, java.util.Map<java.lang.String,java.lang.Object> options) Reads and creates structured document containing header and content chunks.
StructuredDocument	readDocumentStructure(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options) Reads and creates structured document containing header and content chunks.
void	render(java.io.Reader contentReader, java.io.Writer rendererWriter, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
void	render(java.io.Reader contentReader, java.io.Writer rendererWriter, Options options) Deprecated.
void	render(java.io.Reader contentReader, java.io.Writer rendererWriter, OptionsBuilder options) Deprecated.
java.lang.String	render(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
java.lang.String	render(java.lang.String content, Options options) Deprecated.
java.lang.String	render(java.lang.String content, OptionsBuilder options) Deprecated.
java.lang.String[]	renderDirectory(DirectoryWalker directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
java.lang.String[]	renderDirectory(DirectoryWalker directoryWalker, Options options) Deprecated.
java.lang.String[]	renderDirectory(DirectoryWalker directoryWalker, OptionsBuilder options) Deprecated.
java.lang.String	renderFile(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
java.lang.String	renderFile(java.io.File filename, Options options) Deprecated.
java.lang.String	renderFile(java.io.File filename, OptionsBuilder options) Deprecated.
java.lang.String[]	renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
java.lang.String[]	renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, Options options) Deprecated.
java.lang.String[]	renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, OptionsBuilder options) Deprecated.
void	requireLibraries(java.util.Collection<java.lang.String> libraries) Require the given Ruby libraries by name when rendering.
void	requireLibrary(java.lang.String... library) 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.

Methods inherited from class java.lang.Object

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

Field Detail

rubyGemsPreloader

protected RubyGemsPreloader rubyGemsPreloader

rubyRuntime

protected org.jruby.Ruby rubyRuntime

Method Detail

create

public static JRubyAsciidoctor create()

create

public static JRubyAsciidoctor create(java.lang.String gemPath)

create

public static JRubyAsciidoctor create(java.util.List<java.lang.String> loadPaths)

create

public static JRubyAsciidoctor create(java.lang.ClassLoader classloader)

create

public static JRubyAsciidoctor create(java.lang.ClassLoader classloader,
                                      java.lang.String gemPath)

create

public static JRubyAsciidoctor create(java.util.List<java.lang.String> loadPaths,
                                      java.lang.String gemPath)

getRubyRuntime

public org.jruby.Ruby getRubyRuntime()

readDocumentStructure

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

Description copied from interface: Asciidoctor

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.

Specified by:

readDocumentStructure in interface Asciidoctor

Parameters:

filename - to read the attributes.

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

Returns:

structured document.

readDocumentStructure

public StructuredDocument readDocumentStructure(java.lang.String content,
                                                java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: Asciidoctor

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.

Specified by:

readDocumentStructure in interface Asciidoctor

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

public StructuredDocument readDocumentStructure(java.io.Reader contentReader,
                                                java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: Asciidoctor

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.

Specified by:

readDocumentStructure in interface Asciidoctor

Parameters:

contentReader - where asciidoc content is read.

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

Returns:

structured document.

readDocumentHeader

public DocumentHeader readDocumentHeader(java.io.File filename)

Description copied from interface: Asciidoctor

Reads only header parameters instead of all document.

Specified by:

readDocumentHeader in interface Asciidoctor

Parameters:

filename - to read the attributes.

Returns:

header.

readDocumentHeader

public DocumentHeader readDocumentHeader(java.lang.String content)

Description copied from interface: Asciidoctor

Reads only header parameters instead of all document.

Specified by:

readDocumentHeader in interface Asciidoctor

Parameters:

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

Returns:

header.

readDocumentHeader

public DocumentHeader readDocumentHeader(java.io.Reader contentReader)

Description copied from interface: Asciidoctor

Reads only header parameters instead of all document.

Specified by:

readDocumentHeader in interface Asciidoctor

Parameters:

contentReader - where asciidoc content is read.

Returns:

header.

render

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

Deprecated.

Description copied from interface: Asciidoctor

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

Specified by:

render in interface Asciidoctor

Parameters:

content - the AsciiDoc source as String.

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

Returns:

the rendered output String is returned

renderFile

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

Deprecated.

Description copied from interface: Asciidoctor

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.

Specified by:

renderFile in interface Asciidoctor

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.

render

@Deprecated
public 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.

Description copied from interface: Asciidoctor

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

Specified by:

render in interface Asciidoctor

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.

renderFiles

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

Deprecated.

Description copied from interface: Asciidoctor

Parses all files added inside a collection.

Specified by:

renderFiles in interface Asciidoctor

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

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

Deprecated.

Description copied from interface: Asciidoctor

Parses all files added inside a collection.

Specified by:

renderFiles in interface Asciidoctor

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.

renderDirectory

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

Deprecated.

Description copied from interface: Asciidoctor

Parse all AsciiDoc files found using DirectoryWalker instance.

Specified by:

renderDirectory in interface Asciidoctor

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.

render

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

Deprecated.

Description copied from interface: Asciidoctor

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

Specified by:

render in interface Asciidoctor

Parameters:

content - the AsciiDoc source as String.

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

Returns:

the rendered output String is returned

render

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

Deprecated.

Description copied from interface: Asciidoctor

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

Specified by:

render in interface Asciidoctor

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.

renderFile

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

Deprecated.

Description copied from interface: Asciidoctor

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.

Specified by:

renderFile in interface Asciidoctor

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

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

Deprecated.

Description copied from interface: Asciidoctor

Parse all AsciiDoc files found using DirectoryWalker instance.

Specified by:

renderDirectory in interface Asciidoctor

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.

render

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

Deprecated.

Description copied from interface: Asciidoctor

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

Specified by:

render in interface Asciidoctor

Parameters:

content - the AsciiDoc source as String.

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

Returns:

the rendered output String is returned

render

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

Deprecated.

Description copied from interface: Asciidoctor

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

Specified by:

render in interface Asciidoctor

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.

renderFile

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

Deprecated.

Description copied from interface: Asciidoctor

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.

Specified by:

renderFile in interface Asciidoctor

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

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

Deprecated.

Description copied from interface: Asciidoctor

Parse all AsciiDoc files found using DirectoryWalker instance.

Specified by:

renderDirectory in interface Asciidoctor

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

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

Deprecated.

Description copied from interface: Asciidoctor

Parses all files added inside a collection.

Specified by:

renderFiles in interface Asciidoctor

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.

requireLibrary

public void requireLibrary(java.lang.String... library)

Description copied from interface: Asciidoctor

Require the given Ruby libraries by name when rendering.

Specified by:

requireLibrary in interface Asciidoctor

requireLibraries

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

Description copied from interface: Asciidoctor

Require the given Ruby libraries by name when rendering.

Specified by:

requireLibraries in interface Asciidoctor

javaExtensionRegistry

public JavaExtensionRegistry javaExtensionRegistry()

Description copied from interface: Asciidoctor

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

Specified by:

javaExtensionRegistry in interface Asciidoctor

Returns:

Extension Registry object.

rubyExtensionRegistry

public RubyExtensionRegistry rubyExtensionRegistry()

Description copied from interface: Asciidoctor

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

Specified by:

rubyExtensionRegistry in interface Asciidoctor

Returns:

Extension Registry object.

javaConverterRegistry

public JavaConverterRegistry javaConverterRegistry()

Description copied from interface: Asciidoctor

Creates a registry for registering converters.

Specified by:

javaConverterRegistry in interface Asciidoctor

Returns:

Converter Registry object.

unregisterAllExtensions

public void unregisterAllExtensions()

Description copied from interface: Asciidoctor

Unregister all registered extensions.

Specified by:

unregisterAllExtensions in interface Asciidoctor

shutdown

public void shutdown()

Description copied from interface: Asciidoctor

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.

Specified by:

shutdown in interface Asciidoctor

asciidoctorVersion

public java.lang.String asciidoctorVersion()

Description copied from interface: Asciidoctor

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

Specified by:

asciidoctorVersion in interface Asciidoctor

Returns:

Version number.

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

Parameters:

content - the AsciiDoc source as String.

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

Returns:

the rendered output String is returned

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

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 Asciidoctor.convert(String, Map) is the same.

Returns:

the rendered output String is returned

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

Parameters:

content - the AsciiDoc source as String.

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

Returns:

the rendered output String is returned

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

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 Asciidoctor.convert(String, Options) is the same.

Returns:

the rendered output String is returned

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

Parameters:

content - the AsciiDoc source as String.

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

Returns:

the rendered output String is returned

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

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 Asciidoctor.convert(String, OptionsBuilder) is the same.

Returns:

the rendered output String is returned

convert

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

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

Specified by:

convert in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

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.

Specified by:

convertFile in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

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.

Specified by:

convertFile in interface Asciidoctor

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 Asciidoctor.convertFile(File, Map) is the same.

Returns:

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

convertFile

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

Description copied from interface: Asciidoctor

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.

Specified by:

convertFile in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

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.

Specified by:

convertFile in interface Asciidoctor

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 Asciidoctor.convertFile(File, Map) is the same.

Returns:

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

convertFile

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

Description copied from interface: Asciidoctor

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.

Specified by:

convertFile in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

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.

Specified by:

convertFile in interface Asciidoctor

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 Asciidoctor.convertFile(File, Map) is the same.

Returns:

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

convertDirectory

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

Description copied from interface: Asciidoctor

Parse all AsciiDoc files found using DirectoryWalker instance.

Specified by:

convertDirectory in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

Parse all AsciiDoc files found using DirectoryWalker instance.

Specified by:

convertDirectory in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

Parse all AsciiDoc files found using DirectoryWalker instance.

Specified by:

convertDirectory in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

Parses all files added inside a collection.

Specified by:

convertFiles in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

Parses all files added inside a collection.

Specified by:

convertFiles in interface Asciidoctor

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

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

Description copied from interface: Asciidoctor

Parses all files added inside a collection.

Specified by:

convertFiles in interface Asciidoctor

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.

load

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

Description copied from interface: Asciidoctor

Loads AsciiDoc content and returns the Document object.

Specified by:

load in interface Asciidoctor

Parameters:

content - to be parsed.

Returns:

Document of given content.

loadFile

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

Description copied from interface: Asciidoctor

Loads AsciiDoc content from file and returns the Document object.

Specified by:

loadFile in interface Asciidoctor

Parameters:

file - to be loaded.

Returns:

Document of given content.