org.asciidoctor

Class Asciidoctor.Factory

java.lang.Object

org.asciidoctor.Asciidoctor.Factory

Enclosing interface:

Asciidoctor

public static final class Asciidoctor.Factory
extends java.lang.Object

Factory for creating a new instance of Asciidoctor interface.

Method Summary

Modifier and Type	Method and Description
static Asciidoctor	create() Creates a new instance of Asciidoctor.
static Asciidoctor	create(java.lang.ClassLoader classloader) Deprecated. Please use create() and set the TCCL before or create(List) passing the paths that you would have used to create the ClassLoader.
static Asciidoctor	create(java.lang.ClassLoader classloader, java.lang.String gemPath) Deprecated. Please use create(String) and set the TCCL before or create(List, String) passing the paths that you would have used to create the ClassLoader.
static Asciidoctor	create(java.util.List<java.lang.String> loadPaths) Creates a new instance of Asciidoctor and sets loadPath to provided paths.
static Asciidoctor	create(java.util.List<java.lang.String> loadPaths, java.lang.String gemPath) Creates a new instance of Asciidoctor and sets loadPath to provided paths.
static Asciidoctor	create(java.lang.String gemPath) Creates a new instance of Asciidoctor and sets GEM_PATH environment variable to provided gemPath.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Asciidoctor create()

Creates a new instance of Asciidoctor.

Returns:

Asciidoctor instance which uses JRuby to wraps Asciidoctor Ruby calls.

create

public static Asciidoctor create(java.lang.String gemPath)

Creates a new instance of Asciidoctor and sets GEM_PATH environment variable to provided gemPath. This method is mostly used in OSGi environments.

Parameters:

gemPath - where gems are located.

Returns:

Asciidoctor instance which uses JRuby to wraps Asciidoctor Ruby calls.

create

public static Asciidoctor create(java.util.List<java.lang.String> loadPaths)

Creates a new instance of Asciidoctor and sets loadPath to provided paths. This method is mostly used in OSGi environments.

Parameters:

loadPaths - where Ruby libraries are located.

Returns:

Asciidoctor instance which uses JRuby to wraps Asciidoctor Ruby calls.

create

public static Asciidoctor create(java.lang.ClassLoader classloader)

Deprecated. Please use create() and set the TCCL before or create(List) passing the paths that you would have used to create the ClassLoader.

Creates a new instance of Asciidoctor and sets a specific classloader for the JRuby runtime to use. This method is mostly used in environments where different threads may have different classloaders, like build tools sbt or ANT.

Parameters:

classloader -

Returns:

Asciidoctor instance which uses JRuby to wraps Asciidoctor Ruby calls.

create

public static Asciidoctor create(java.lang.ClassLoader classloader,
                                 java.lang.String gemPath)

Deprecated. Please use create(String) and set the TCCL before or create(List, String) passing the paths that you would have used to create the ClassLoader.

Cerates a new instance of Asciidoctor and sets a specific classloader and gempath for the JRuby runtime to use.

Parameters:

classloader -

gemPath -

Returns:

Asciidoctor instance which uses JRuby to wraps Asciidoctor

create

public static Asciidoctor create(java.util.List<java.lang.String> loadPaths,
                                 java.lang.String gemPath)

Creates a new instance of Asciidoctor and sets loadPath to provided paths. The gem path of the Ruby instance is set to the gemPath parameter.

Parameters:

loadPaths - where Ruby libraries are located.

gemPath - where gems are located.

Returns:

Asciidoctor instance which uses JRuby to wraps Asciidoctor Ruby calls.