public interface Asciidoctor
Modifier and Type | Interface and Description |
---|---|
static class |
Asciidoctor.Factory
Factory for creating a new instance of Asciidoctor interface.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
STRUCTURE_MAX_LEVEL |
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(java.lang.Iterable<java.io.File> directoryWalker,
java.util.Map<java.lang.String,java.lang.Object> options)
Parse all AsciiDoc files found using DirectoryWalker instance.
|
java.lang.String[] |
convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
Options options)
Parse all AsciiDoc files found using DirectoryWalker instance.
|
java.lang.String[] |
convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
OptionsBuilder options)
Parse all AsciiDoc files found using DirectoryWalker instance.
|
java.lang.String |
convertFile(java.io.File file,
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 file,
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 file,
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 file,
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 file,
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 file,
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> files,
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> files,
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 file)
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 |
requireLibraries(java.util.Collection<java.lang.String> requiredLibraries)
Require the given libraries by name when rendering.
|
void |
requireLibrary(java.lang.String... requiredLibraries)
Require the given 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.
|
SyntaxHighlighterRegistry |
syntaxHighlighterRegistry()
Creates a registry for registering converters.
|
void |
unregisterAllExtensions()
Unregister all registered extensions.
|
void |
unregisterLogHandler(LogHandler logHandler) |
default <T> T |
unwrap(java.lang.Class<T> clazz) |
static final java.lang.String STRUCTURE_MAX_LEVEL
java.lang.String convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
Document
and
render it to the specified backend format.
Accepts input as String object.
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).<T> T convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Class<T> expectedResult)
Document
and
render it to the specified backend format.
Accepts input as String object.
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.java.lang.String convert(java.lang.String content, Options options)
Document
and
render it to the specified backend format.
Accepts input as String object.
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).<T> T convert(java.lang.String content, Options options, java.lang.Class<T> expectedResult)
Document
and
render it to the specified backend format.
Accepts input as String object.
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.java.lang.String convert(java.lang.String content, OptionsBuilder options)
Document
and
render it to the specified backend format.
Accepts input as String object.
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).<T> T convert(java.lang.String content, OptionsBuilder options, java.lang.Class<T> expectedResult)
Document
and
render it to the specified backend format.
Accepts input as String object.
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.void convert(java.io.Reader contentReader, java.io.Writer rendererWriter, java.util.Map<java.lang.String,java.lang.Object> options) throws java.io.IOException
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: {}).java.io.IOException
- if an error occurs while writing rendered content, this
exception is thrown.void convert(java.io.Reader contentReader, java.io.Writer rendererWriter, Options options) throws java.io.IOException
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: {}).java.io.IOException
- if an error occurs while writing rendered content, this
exception is thrown.void convert(java.io.Reader contentReader, java.io.Writer rendererWriter, OptionsBuilder options) throws java.io.IOException
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: {}).java.io.IOException
- if an error occurs while writing rendered content, this
exception is thrown.java.lang.String convertFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options)
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.
file
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).<T> T convertFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Class<T> expectedResult)
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.
file
- 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.java.lang.String convertFile(java.io.File file, Options options)
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.
file
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).<T> T convertFile(java.io.File file, Options options, java.lang.Class<T> expectedResult)
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.
file
- 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.java.lang.String convertFile(java.io.File file, OptionsBuilder options)
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.
file
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).<T> T convertFile(java.io.File file, OptionsBuilder options, java.lang.Class<T> expectedResult)
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.
file
- 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.java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options)
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker, Options options)
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker, OptionsBuilder options)
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String[] convertFiles(java.util.Collection<java.io.File> files, java.util.Map<java.lang.String,java.lang.Object> options)
files
- to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, Options options)
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String[] convertFiles(java.util.Collection<java.io.File> files, OptionsBuilder options)
files
- to be rendered.options
- a Hash of options to control processing (default: {}).void requireLibrary(java.lang.String... requiredLibraries)
requiredLibraries
- void requireLibraries(java.util.Collection<java.lang.String> requiredLibraries)
requiredLibraries
- DocumentHeader readDocumentHeader(java.io.File file)
file
- to read the attributes.DocumentHeader readDocumentHeader(java.lang.String content)
content
- where rendered content is written. Writer is flushed, but not
closed.DocumentHeader readDocumentHeader(java.io.Reader contentReader)
contentReader
- where asciidoc content is read.JavaExtensionRegistry javaExtensionRegistry()
RubyExtensionRegistry rubyExtensionRegistry()
JavaConverterRegistry javaConverterRegistry()
SyntaxHighlighterRegistry syntaxHighlighterRegistry()
This API is experimental and might change in an incompatible way in a minor version update!
ExtensionGroup createGroup()
ExtensionGroup createGroup(java.lang.String groupName)
void unregisterAllExtensions()
void shutdown()
java.lang.String asciidoctorVersion()
Document load(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
content
- to be parsed.options
- Document loadFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options)
file
- to be loaded.options
- void registerLogHandler(LogHandler logHandler)
void unregisterLogHandler(LogHandler logHandler)
default <T> T unwrap(java.lang.Class<T> clazz)