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
DocumentRuby 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
DocumentRuby 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
DocumentRuby 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
DocumentRuby 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
DocumentRuby 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
DocumentRuby 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.
|
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)
Parse the document read from reader, and rendered result is sent to
writer.
|
void |
render(java.io.Reader contentReader,
java.io.Writer rendererWriter,
Options options)
Parse the document read from reader, and rendered result is sent to
writer.
|
void |
render(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 |
render(java.lang.String content,
java.util.Map<java.lang.String,java.lang.Object> options)
Parse the AsciiDoc source input into an Document
DocumentRuby and
render it to the specified backend format. |
java.lang.String |
render(java.lang.String content,
Options options)
Parse the AsciiDoc source input into an Document
DocumentRuby and
render it to the specified backend format. |
java.lang.String |
render(java.lang.String content,
OptionsBuilder options)
Parse the AsciiDoc source input into an Document
DocumentRuby and
render it to the specified backend format. |
java.lang.String[] |
renderDirectory(DirectoryWalker directoryWalker,
java.util.Map<java.lang.String,java.lang.Object> options)
Parse all AsciiDoc files found using DirectoryWalker instance.
|
java.lang.String[] |
renderDirectory(DirectoryWalker directoryWalker,
Options options)
Parse all AsciiDoc files found using DirectoryWalker instance.
|
java.lang.String[] |
renderDirectory(DirectoryWalker directoryWalker,
OptionsBuilder options)
Parse all AsciiDoc files found using DirectoryWalker instance.
|
java.lang.String |
renderFile(java.io.File filename,
java.util.Map<java.lang.String,java.lang.Object> options)
Parse the AsciiDoc source input into an Document
DocumentRuby and
render it to the specified backend format. |
java.lang.String |
renderFile(java.io.File filename,
Options options)
Parse the AsciiDoc source input into an Document
DocumentRuby and
render it to the specified backend format. |
java.lang.String |
renderFile(java.io.File filename,
OptionsBuilder options)
Parse the AsciiDoc source input into an Document
DocumentRuby and
render it to the specified backend format. |
java.lang.String[] |
renderFiles(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[] |
renderFiles(java.util.Collection<java.io.File> asciidoctorFiles,
Options options)
Parses all files added inside a collection.
|
java.lang.String[] |
renderFiles(java.util.Collection<java.io.File> asciidoctorFiles,
OptionsBuilder options)
Parses all files added inside a collection.
|
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.
|
static final java.lang.String STRUCTURE_MAX_LEVEL
java.lang.String render(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
DocumentRuby
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: {}).java.lang.String render(java.lang.String content, Options options)
DocumentRuby
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: {}).java.lang.String render(java.lang.String content, OptionsBuilder options)
DocumentRuby
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: {}).void render(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 render(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 render(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 renderFile(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options)
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.filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).java.lang.String renderFile(java.io.File filename, Options options)
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.filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).java.lang.String renderFile(java.io.File filename, OptionsBuilder options)
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.filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).java.lang.String[] renderDirectory(DirectoryWalker 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[] renderDirectory(DirectoryWalker 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[] renderDirectory(DirectoryWalker 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[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options)
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String[] renderFiles(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[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, OptionsBuilder options)
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).java.lang.String convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
DocumentRuby
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: {}).java.lang.String convert(java.lang.String content, Options options)
DocumentRuby
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: {}).java.lang.String convert(java.lang.String content, OptionsBuilder options)
DocumentRuby
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: {}).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 filename, java.util.Map<java.lang.String,java.lang.Object> options)
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.filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).java.lang.String convertFile(java.io.File filename, Options options)
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.filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).java.lang.String convertFile(java.io.File filename, OptionsBuilder options)
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.filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).java.lang.String[] convertDirectory(DirectoryWalker 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(DirectoryWalker 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(DirectoryWalker 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> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options)
asciidoctorFiles
- 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> asciidoctorFiles, OptionsBuilder options)
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).StructuredDocument readDocumentStructure(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options)
filename
- to read the attributes.options
- a Hash of options to control processing (default: {}).StructuredDocument readDocumentStructure(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
content
- where rendered content is written. Writer is flushed, but not
closed.options
- a Hash of options to control processing (default: {}).StructuredDocument readDocumentStructure(java.io.Reader contentReader, java.util.Map<java.lang.String,java.lang.Object> options)
contentReader
- where asciidoc content is read.options
- a Hash of options to control processing (default: {}).DocumentHeader readDocumentHeader(java.io.File filename)
filename
- 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.void requireLibrary(java.lang.String... requiredLibraries)
requiredLibraries
- void requireLibraries(java.util.Collection<java.lang.String> requiredLibraries)
requiredLibraries
- JavaExtensionRegistry javaExtensionRegistry()
RubyExtensionRegistry rubyExtensionRegistry()
JavaConverterRegistry javaConverterRegistry()
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
-