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 |
STRUCTURE_MAX_LEVEL| 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, 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.
|
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 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.
|
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.
|
void |
log(LogRecord logRecord) |
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> libraries)
Require the given libraries by name when rendering.
|
void |
requireLibrary(java.lang.String... library)
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) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitunwrapprotected 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.AutoCloseableclose in interface Asciidoctorpublic void registerLogHandler(LogHandler logHandler)
registerLogHandler in interface Asciidoctorpublic void unregisterLogHandler(LogHandler logHandler)
unregisterLogHandler in interface Asciidoctorpublic org.jruby.Ruby getRubyRuntime()
public DocumentHeader readDocumentHeader(java.io.File file)
AsciidoctorreadDocumentHeader in interface Asciidoctorfile - to read the attributes.public DocumentHeader readDocumentHeader(java.lang.String content)
AsciidoctorreadDocumentHeader in interface Asciidoctorcontent - where rendered content is written. Writer is flushed, but not
closed.public DocumentHeader readDocumentHeader(java.io.Reader contentReader)
AsciidoctorreadDocumentHeader in interface AsciidoctorcontentReader - where asciidoc content is read.public void requireLibrary(java.lang.String... library)
AsciidoctorrequireLibrary in interface Asciidoctorpublic void requireLibraries(java.util.Collection<java.lang.String> libraries)
AsciidoctorrequireLibraries in interface Asciidoctorpublic JavaExtensionRegistry javaExtensionRegistry()
AsciidoctorjavaExtensionRegistry in interface Asciidoctorpublic RubyExtensionRegistry rubyExtensionRegistry()
AsciidoctorrubyExtensionRegistry in interface Asciidoctorpublic JavaConverterRegistry javaConverterRegistry()
AsciidoctorjavaConverterRegistry in interface Asciidoctorpublic SyntaxHighlighterRegistry syntaxHighlighterRegistry()
AsciidoctorThis API is experimental and might change in an incompatible way in a minor version update!
syntaxHighlighterRegistry in interface Asciidoctorpublic void unregisterAllExtensions()
AsciidoctorunregisterAllExtensions in interface Asciidoctorpublic void shutdown()
Asciidoctorshutdown in interface Asciidoctorpublic java.lang.String asciidoctorVersion()
AsciidoctorasciidoctorVersion in interface Asciidoctorpublic java.lang.String convert(java.lang.String content,
java.util.Map<java.lang.String,java.lang.Object> options)
AsciidoctorDocument and
render it to the specified backend format.
Accepts input as String object.
convert in interface Asciidoctorcontent - the AsciiDoc source as String.options - a Hash 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)
AsciidoctorDocument and
render it to the specified backend format.
Accepts input as String object.
convert in interface Asciidoctorcontent - 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.public java.lang.String convert(java.lang.String content,
Options options)
AsciidoctorDocument and
render it to the specified backend format.
Accepts input as String object.
convert in interface Asciidoctorcontent - the AsciiDoc source as String.options - a Hash of options to control processing (default: {}).public <T> T convert(java.lang.String content,
Options options,
java.lang.Class<T> expectedResult)
AsciidoctorDocument and
render it to the specified backend format.
Accepts input as String object.
convert in interface Asciidoctorcontent - 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.public java.lang.String convert(java.lang.String content,
OptionsBuilder options)
AsciidoctorDocument and
render it to the specified backend format.
Accepts input as String object.
convert in interface Asciidoctorcontent - the AsciiDoc source as String.options - a Hash of options to control processing (default: {}).public <T> T convert(java.lang.String content,
OptionsBuilder options,
java.lang.Class<T> expectedResult)
AsciidoctorDocument and
render it to the specified backend format.
Accepts input as String object.
convert in interface Asciidoctorcontent - 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.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
Asciidoctorconvert in interface AsciidoctorcontentReader - 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
Asciidoctorconvert in interface AsciidoctorcontentReader - 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
Asciidoctorconvert in interface AsciidoctorcontentReader - 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 file,
java.util.Map<java.lang.String,java.lang.Object> options)
AsciidoctorDocument 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 Asciidoctorfile - an input Asciidoctor file.options - a Hash 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)
AsciidoctorDocument 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 Asciidoctorfile - 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.public java.lang.String convertFile(java.io.File file,
Options options)
AsciidoctorDocument 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 Asciidoctorfile - an input Asciidoctor file.options - a Hash of options to control processing (default: {}).public <T> T convertFile(java.io.File file,
Options options,
java.lang.Class<T> expectedResult)
AsciidoctorDocument 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 Asciidoctorfile - 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.public java.lang.String convertFile(java.io.File file,
OptionsBuilder options)
AsciidoctorDocument 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 Asciidoctorfile - an input Asciidoctor file.options - a Hash of options to control processing (default: {}).public <T> T convertFile(java.io.File file,
OptionsBuilder options,
java.lang.Class<T> expectedResult)
AsciidoctorDocument 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 Asciidoctorfile - 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.public java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
java.util.Map<java.lang.String,java.lang.Object> options)
AsciidoctorconvertDirectory in interface AsciidoctordirectoryWalker - strategy used to retrieve all files to be rendered.options - a Hash of options to control processing (default: {}).public java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
Options options)
AsciidoctorconvertDirectory in interface AsciidoctordirectoryWalker - strategy used to retrieve all files to be rendered.options - a Hash of options to control processing (default: {}).public java.lang.String[] convertDirectory(java.lang.Iterable<java.io.File> directoryWalker,
OptionsBuilder options)
AsciidoctorconvertDirectory in interface AsciidoctordirectoryWalker - 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> files,
java.util.Map<java.lang.String,java.lang.Object> options)
AsciidoctorconvertFiles in interface 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)
AsciidoctorconvertFiles in interface AsciidoctorasciidoctorFiles - to be rendered.options - a Hash of options to control processing (default: {}).public java.lang.String[] convertFiles(java.util.Collection<java.io.File> files,
OptionsBuilder options)
AsciidoctorconvertFiles in interface 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)
Asciidoctorload in interface Asciidoctorcontent - to be parsed.public Document loadFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options)
AsciidoctorloadFile in interface Asciidoctorfile - to be loaded.public ExtensionGroup createGroup()
AsciidoctorcreateGroup in interface Asciidoctorpublic ExtensionGroup createGroup(java.lang.String groupName)
AsciidoctorcreateGroup in interface Asciidoctorpublic void log(LogRecord logRecord)
log in interface LogHandler