public class JRubyAsciidoctor extends java.lang.Object implements Asciidoctor, LogHandler
Asciidoctor.Factory
Modifier and Type | Field and Description |
---|---|
protected RubyGemsPreloader |
rubyGemsPreloader |
protected org.jruby.Ruby |
rubyRuntime |
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.
|
static Asciidoctor |
create() |
static Asciidoctor |
create(java.lang.ClassLoader classloader) |
static Asciidoctor |
create(java.lang.ClassLoader classloader,
java.lang.String gemPath) |
static Asciidoctor |
create(java.util.List<java.lang.String> loadPaths) |
static Asciidoctor |
create(java.lang.String gemPath) |
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.
|
void |
log(LogRecord logRecord) |
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 |
registerLogHandler(LogHandler logHandler) |
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.
|
void |
unregisterLogHandler(LogHandler logHandler) |
protected RubyGemsPreloader rubyGemsPreloader
protected org.jruby.Ruby rubyRuntime
public static Asciidoctor create()
public static Asciidoctor create(java.lang.String gemPath)
public static Asciidoctor create(java.util.List<java.lang.String> loadPaths)
public static Asciidoctor create(java.lang.ClassLoader classloader)
public static Asciidoctor create(java.lang.ClassLoader classloader, java.lang.String gemPath)
public StructuredDocument readDocumentStructure(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
readDocumentStructure
in interface Asciidoctor
filename
- to read the attributes.options
- a Hash of options to control processing (default: {}).public StructuredDocument readDocumentStructure(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
readDocumentStructure
in interface Asciidoctor
content
- where rendered content is written. Writer is flushed, but not
closed.options
- a Hash of options to control processing (default: {}).public StructuredDocument readDocumentStructure(java.io.Reader contentReader, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
readDocumentStructure
in interface Asciidoctor
contentReader
- where asciidoc content is read.options
- a Hash of options to control processing (default: {}).public DocumentHeader readDocumentHeader(java.io.File filename)
Asciidoctor
readDocumentHeader
in interface Asciidoctor
filename
- to read the attributes.public DocumentHeader readDocumentHeader(java.lang.String content)
Asciidoctor
readDocumentHeader
in interface Asciidoctor
content
- where rendered content is written. Writer is flushed, but not
closed.public DocumentHeader readDocumentHeader(java.io.Reader contentReader)
Asciidoctor
readDocumentHeader
in interface Asciidoctor
contentReader
- where asciidoc content is read.@Deprecated public java.lang.String render(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
DocumentRuby
and
render it to the specified backend format.
Accepts input as String object.render
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String renderFile(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
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.renderFile
in interface Asciidoctor
filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).@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
Asciidoctor
render
in interface Asciidoctor
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.@Deprecated public java.lang.String[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
renderFiles
in interface Asciidoctor
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, Options options)
Asciidoctor
renderFiles
in interface Asciidoctor
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String[] renderDirectory(DirectoryWalker directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
renderDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String render(java.lang.String content, Options options)
Asciidoctor
DocumentRuby
and
render it to the specified backend format.
Accepts input as String object.render
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).@Deprecated public void render(java.io.Reader contentReader, java.io.Writer rendererWriter, Options options) throws java.io.IOException
Asciidoctor
render
in interface Asciidoctor
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.@Deprecated public java.lang.String renderFile(java.io.File filename, Options options)
Asciidoctor
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.renderFile
in interface Asciidoctor
filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String[] renderDirectory(DirectoryWalker directoryWalker, Options options)
Asciidoctor
renderDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String render(java.lang.String content, OptionsBuilder options)
Asciidoctor
DocumentRuby
and
render it to the specified backend format.
Accepts input as String object.render
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).@Deprecated public void render(java.io.Reader contentReader, java.io.Writer rendererWriter, OptionsBuilder options) throws java.io.IOException
Asciidoctor
render
in interface Asciidoctor
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.@Deprecated public java.lang.String renderFile(java.io.File filename, OptionsBuilder options)
Asciidoctor
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.renderFile
in interface Asciidoctor
filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String[] renderDirectory(DirectoryWalker directoryWalker, OptionsBuilder options)
Asciidoctor
renderDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).@Deprecated public java.lang.String[] renderFiles(java.util.Collection<java.io.File> asciidoctorFiles, OptionsBuilder options)
Asciidoctor
renderFiles
in interface Asciidoctor
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).public void requireLibrary(java.lang.String... library)
Asciidoctor
requireLibrary
in interface Asciidoctor
public void requireLibraries(java.util.Collection<java.lang.String> libraries)
Asciidoctor
requireLibraries
in interface Asciidoctor
public JavaExtensionRegistry javaExtensionRegistry()
Asciidoctor
javaExtensionRegistry
in interface Asciidoctor
public RubyExtensionRegistry rubyExtensionRegistry()
Asciidoctor
rubyExtensionRegistry
in interface Asciidoctor
public JavaConverterRegistry javaConverterRegistry()
Asciidoctor
javaConverterRegistry
in interface Asciidoctor
public void unregisterAllExtensions()
Asciidoctor
unregisterAllExtensions
in interface Asciidoctor
public void shutdown()
Asciidoctor
shutdown
in interface Asciidoctor
public java.lang.String asciidoctorVersion()
Asciidoctor
asciidoctorVersion
in interface Asciidoctor
public java.lang.String convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
DocumentRuby
and
render it to the specified backend format.
Accepts input as String object.convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).public java.lang.String convert(java.lang.String content, Options options)
Asciidoctor
DocumentRuby
and
render it to the specified backend format.
Accepts input as String object.convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).public java.lang.String convert(java.lang.String content, OptionsBuilder options)
Asciidoctor
DocumentRuby
and
render it to the specified backend format.
Accepts input as String object.convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Hash of options to control processing (default: {}).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
Asciidoctor
convert
in interface Asciidoctor
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.public void convert(java.io.Reader contentReader, java.io.Writer rendererWriter, Options options) throws java.io.IOException
Asciidoctor
convert
in interface Asciidoctor
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.public void convert(java.io.Reader contentReader, java.io.Writer rendererWriter, OptionsBuilder options) throws java.io.IOException
Asciidoctor
convert
in interface Asciidoctor
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.public java.lang.String convertFile(java.io.File filename, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
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.convertFile
in interface Asciidoctor
filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).public java.lang.String convertFile(java.io.File filename, Options options)
Asciidoctor
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.convertFile
in interface Asciidoctor
filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).public java.lang.String convertFile(java.io.File filename, OptionsBuilder options)
Asciidoctor
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.convertFile
in interface Asciidoctor
filename
- an input Asciidoctor file.options
- a Hash of options to control processing (default: {}).public java.lang.String[] convertDirectory(DirectoryWalker directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
convertDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).public java.lang.String[] convertDirectory(DirectoryWalker directoryWalker, Options options)
Asciidoctor
convertDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).public java.lang.String[] convertDirectory(DirectoryWalker directoryWalker, OptionsBuilder options)
Asciidoctor
convertDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Hash of options to control processing (default: {}).public java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
convertFiles
in interface Asciidoctor
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).public java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, Options options)
Asciidoctor
convertFiles
in interface Asciidoctor
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).public java.lang.String[] convertFiles(java.util.Collection<java.io.File> asciidoctorFiles, OptionsBuilder options)
Asciidoctor
convertFiles
in interface Asciidoctor
asciidoctorFiles
- to be rendered.options
- a Hash of options to control processing (default: {}).public Document load(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
load
in interface Asciidoctor
content
- to be parsed.public Document loadFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
loadFile
in interface Asciidoctor
file
- to be loaded.public void registerLogHandler(LogHandler logHandler)
registerLogHandler
in interface Asciidoctor
public void unregisterLogHandler(LogHandler logHandler)
unregisterLogHandler
in interface Asciidoctor
public ExtensionGroup createGroup()
Asciidoctor
createGroup
in interface Asciidoctor
public ExtensionGroup createGroup(java.lang.String groupName)
Asciidoctor
createGroup
in interface Asciidoctor
public void log(LogRecord logRecord)
log
in interface LogHandler