public class JRubyAsciidoctor extends java.lang.Object implements AsciidoctorJRuby, LogHandler
AsciidoctorJRuby.Factory
Modifier and Type | Field and Description |
---|---|
protected RubyGemsPreloader |
rubyGemsPreloader |
protected org.jruby.Ruby |
rubyRuntime |
Constructor and Description |
---|
JRubyAsciidoctor() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
asciidoctorVersion()
Method that gets the asciidoctor version which is being used..
|
void |
close() |
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 sending the converted result to
writer.
|
void |
convert(java.io.Reader contentReader,
java.io.Writer rendererWriter,
Options options)
Parse the document read from reader sending the converted result to
writer.
|
void |
convert(java.io.Reader contentReader,
java.io.Writer rendererWriter,
OptionsBuilder options)
Parse the document read from reader sending the converted result 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
convert 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
convert 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
convert 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
convert 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
convert 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
convert 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)
Convert all AsciiDoc files found in directoryWalker.
|
java.lang.String[] |
convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
Options options)
Convert all AsciiDoc files found in directoryWalker.
|
java.lang.String[] |
convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
OptionsBuilder options)
Convert all AsciiDoc files found in directoryWalker.
|
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
convert 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
convert 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
convert 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
convert 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
convert 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
convert 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)
Convert all files from a collection.
|
java.lang.String[] |
convertFiles(java.util.Collection<java.io.File> asciidoctorFiles,
Options options)
Convert all files from a collection.
|
java.lang.String[] |
convertFiles(java.util.Collection<java.io.File> files,
OptionsBuilder options)
Convert all files from 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) |
ExtensionGroup |
createGroup()
Creates an ExtensionGroup that can be used to register and unregister multiples extensions all at once.
|
ExtensionGroup |
createGroup(java.lang.String groupName)
Creates an ExtensionGroup that can be used to register and unregister multiples extensions all at once.
|
org.jruby.Ruby |
getRubyRuntime() |
JavaConverterRegistry |
javaConverterRegistry()
Creates a registry for registering Java converters.
|
JavaExtensionRegistry |
javaExtensionRegistry()
Creates an extension registry ready to be used for registering Java extensions.
|
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 |
load(java.lang.String content,
Options 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.
|
Document |
loadFile(java.io.File file,
Options options)
Loads AsciiDoc content from file and returns the Document object.
|
void |
log(LogRecord logRecord)
Process a log record.
|
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)
Register a
LogHandler to capture Asciidoctor message records. |
void |
requireLibraries(java.util.Collection<java.lang.String> libraries)
Loads the given Ruby gem in requiredLibraries by name.
|
void |
requireLibrary(java.lang.String... library)
Loads the given Ruby gem(s) by name.
|
RubyExtensionRegistry |
rubyExtensionRegistry()
Creates an Ruby extension registry ready to be used for registering Ruby extension.
|
void |
shutdown()
This method frees all resources consumed by AsciidoctorJ module.
|
SyntaxHighlighterRegistry |
syntaxHighlighterRegistry()
Creates a registry for registering Java syntax highlighter.
|
void |
unregisterAllExtensions()
Unregister all registered extensions.
|
void |
unregisterLogHandler(LogHandler logHandler)
Unregister a
LogHandler . |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
unwrap
protected RubyGemsPreloader rubyGemsPreloader
protected org.jruby.Ruby rubyRuntime
public static JRubyAsciidoctor create()
public static JRubyAsciidoctor create(java.lang.String gemPath)
public static JRubyAsciidoctor create(java.util.List<java.lang.String> loadPaths)
public static JRubyAsciidoctor create(java.lang.ClassLoader classloader)
public static JRubyAsciidoctor create(java.lang.ClassLoader classloader, java.lang.String gemPath)
public static JRubyAsciidoctor create(java.util.List<java.lang.String> loadPaths, java.lang.String gemPath)
public void close()
close
in interface java.lang.AutoCloseable
close
in interface Asciidoctor
public void registerLogHandler(LogHandler logHandler)
Asciidoctor
LogHandler
to capture Asciidoctor message records.registerLogHandler
in interface Asciidoctor
logHandler
- handler instance.public void unregisterLogHandler(LogHandler logHandler)
Asciidoctor
LogHandler
.unregisterLogHandler
in interface Asciidoctor
logHandler
- handler instance.public org.jruby.Ruby getRubyRuntime()
public DocumentHeader readDocumentHeader(java.io.File file)
Asciidoctor
readDocumentHeader
in interface Asciidoctor
file
- to read the attributes.public DocumentHeader readDocumentHeader(java.lang.String content)
Asciidoctor
readDocumentHeader
in interface Asciidoctor
content
- where converted 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.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 SyntaxHighlighterRegistry syntaxHighlighterRegistry()
Asciidoctor
This API is experimental and might change in an incompatible way in a minor version update!
syntaxHighlighterRegistry
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
Document
and
convert it to the specified backend format.
Accepts input as String object.
convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Map of options to control processing (default: {}).public <T> T convert(java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Class<T> expectedResult)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as String object.
convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Map 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.public java.lang.String convert(java.lang.String content, Options options)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as String object.
convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- options to control processing (default: empty).public <T> T convert(java.lang.String content, Options options, java.lang.Class<T> expectedResult)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as String object.
convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- options to control processing (default: empty).expectedResult
- the expected return type. Usually String
for HTML based formats.
In this case Asciidoctor.convert(String, Options)
is the same.public java.lang.String convert(java.lang.String content, OptionsBuilder options)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as String object.
convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Map of options to control processing (default: {}).public <T> T convert(java.lang.String content, OptionsBuilder options, java.lang.Class<T> expectedResult)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as String object.
convert
in interface Asciidoctor
content
- the AsciiDoc source as String.options
- a Map 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.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 Map 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
- options to control processing (default: empty).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 Map 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 file, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as File.
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
file
- an input Asciidoctor file.options
- a Map of options to control processing (default: {}).public <T> T convertFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Class<T> expectedResult)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as File.
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
file
- an input Asciidoctor file.options
- a Map 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.public java.lang.String convertFile(java.io.File file, Options options)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as File.
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
file
- an input Asciidoctor file.options
- options to control processing (default: empty).public <T> T convertFile(java.io.File file, Options options, java.lang.Class<T> expectedResult)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as File.
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
file
- an input Asciidoctor file.options
- options to control processing (default: empty).expectedResult
- the expected return type. Usually String
for HTML based formats.
In this case Asciidoctor.convertFile(File, Map)
is the same.public java.lang.String convertFile(java.io.File file, OptionsBuilder options)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as File.
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
file
- an input Asciidoctor file.options
- a Map of options to control processing (default: {}).public <T> T convertFile(java.io.File file, OptionsBuilder options, java.lang.Class<T> expectedResult)
Asciidoctor
Document
and
convert it to the specified backend format.
Accepts input as File.
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
file
- an input Asciidoctor file.options
- a Map 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.public java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
AsciiDocDirectoryWalker
for reference strategy.convertDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Map of options to control processing (default: {}).public java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker, Options options)
Asciidoctor
AsciiDocDirectoryWalker
for reference strategy.convertDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- options to control processing (default: empty).public java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker, OptionsBuilder options)
Asciidoctor
AsciiDocDirectoryWalker
for reference strategy.convertDirectory
in interface Asciidoctor
directoryWalker
- strategy used to retrieve all files to be rendered.options
- a Map of options to control processing (default: {}).public java.lang.String[] convertFiles(java.util.Collection<java.io.File> files, java.util.Map<java.lang.String,java.lang.Object> options)
Asciidoctor
convertFiles
in interface Asciidoctor
files
- to be converted.options
- a Map 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 converted.options
- options to control processing (default: empty).public java.lang.String[] convertFiles(java.util.Collection<java.io.File> files, OptionsBuilder options)
Asciidoctor
convertFiles
in interface Asciidoctor
files
- to be converted.options
- a Map 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.options
- a Map of options to control processing (default: {}).public Document load(java.lang.String content, Options options)
Asciidoctor
load
in interface Asciidoctor
content
- to be parsed.options
- options to control processing (default: empty).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 parsed.options
- a Map of options to control processing (default: {}).public Document loadFile(java.io.File file, Options options)
Asciidoctor
loadFile
in interface Asciidoctor
file
- to be parsed.options
- options to control processing (default: empty).public ExtensionGroup createGroup()
Asciidoctor
createGroup
in interface Asciidoctor
public ExtensionGroup createGroup(java.lang.String groupName)
Asciidoctor
createGroup
in interface Asciidoctor
groupName
- to assign to the ExtensionGroup.public void log(LogRecord logRecord)
LogHandler
log
in interface LogHandler