AsciidoctorJExtension (asciidoctor-gradle-jvm 4.0.2 API)

org.asciidoctor.gradle.jvm.AsciidoctorJExtension

@groovy.transform.CompileStatic
@SuppressWarnings(value: MethodCount)
@NonExtensible
class AsciidoctorJExtension
extends org.asciidoctor.gradle.base.AbstractImplementationEngineExtension

Extension for configuring AsciidoctorJ. It can be used as both a project and a task extension.

Authors:: Schalk W. Cronjé

Since:: 2.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`NAME`

Inherited fields
Fields inherited from class	Fields
`class org.asciidoctor.gradle.base.AbstractImplementationEngineExtension`	`__$stMC, __$stMC`

Properties Summary

Properties
Type	Name and description
`List<Object>`	`docExtensions`
`List<Pattern>`	`fatalWarnings`
`String`	`jrubyVersion`
`LogLevel`	`logLevel`
`LogLevel`	`logLevel`
`Map<String, Object>`	`options`
`List<String>`	`requires`
`String`	`version`

Constructor Summary

Constructors
Constructor and description
`AsciidoctorJExtension (Project project)` Attach extension to a project.
`AsciidoctorJExtension (Task task)` Attach extension to a task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`docExtensions(groovy.lang.Closure<?>[] exts)` Defines extensions to be registered.
	`void`	`docExtensions(File[] exts)` Defines extensions to be registered.
	`void`	`docExtensions(String[] exts)` Defines extensions to be registered.
	`void`	`docExtensions(Provider<?>[] exts)` Defines extensions to be registered.
	`void`	`docExtensions(Dependency[] exts)` Defines extensions to be registered.
	`void`	`docExtensions(Project[] exts)` Defines extensions to be registered.
	`void`	`docExtensionsFromExternal(String[] exts)` Defines extensions to be registered.
	`void`	`fatalWarnings(Object[] patterns)` Adds additional message patterns for treating Asciidoctor log messages as errors.
	`Configuration`	`getConfiguration()` Returns a runConfiguration of the configured AsciidoctorJ dependencies.
	`List<Object>`	`getDocExtensions()` Return extensions to be registered.
	`List<Pattern>`	`getFatalWarnings()` Provide patterns for Asciidoctor messages that are treated as failures.
	`String`	`getJrubyVersion()` The version of JRuby to use.
	`LogLevel`	`getLogLevel()` The level at which the AsciidoctorJ process should be logging.
	`AsciidoctorJModules`	`getModules()` Additional AsciidoctorJ modules to be configured.
	`Map<String, Object>`	`getOptions()` Returns all of the Asciidoctor options.
	`List<String>`	`getRequires()` Returns the set of Ruby modules to be included.
	`String`	`getVersion()` Version of AsciidoctorJ that should be used.
	`void`	`loadJRubyResolutionStrategy(Configuration cfg)` Loads a JRUBy resolution rule onto the given configuration.
	`Pattern`	`missingIncludes()` Returns a patterns suitable for detecting missing include files.
	`void`	`modules(groovy.lang.Closure cfg)` Configure modules via a closure.
	`void`	`modules(Action<AsciidoctorJModules> cfg)` Configure modules via an `Action`.
	`void`	`options(Map m)` Add additional Asciidoctor options
	`void`	`requires(Object[] b)` Appends new set of Ruby modules to be included.
	`void`	`resolutionStrategy(Action<ResolutionStrategy> strategy)` Adds rules to the resolution strategy for resolving asciidoctorj related dependencies
	`void`	`resolutionStrategy(groovy.lang.Closure strategy)` Adds rules to the resolution strategy for resolving asciidoctorj related dependencies
	`void`	`setDocExtensions(Iterable<Object> newExtensions)` Clears the existing list of extensions and replace with a new set.
	`void`	`setFatalWarnings(Iterable<Object> patterns)` Provide patterns for Asciidoctor messages that are treated as failures.
	`void`	`setJrubyVersion(Object v)` Set a version of JRuby to use.
	`void`	`setLogLevel(LogLevel logLevel)` Set the level at which the AsciidoctorJ process should be logging.
	`void`	`setLogLevel(String logLevel)` Set the level at which the AsciidoctorJ process should be logging.
	`void`	`setOptions(Map m)` Apply a new set of Asciidoctor options, clearing any options previously set.
	`void`	`setRequires(Object[] b)` Applies a new set of Ruby modules to be included, clearing any previous set.
	`void`	`setVersion(Object v)` Set a new version to use.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.asciidoctor.gradle.base.AbstractImplementationEngineExtension`	org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#attributeProvider(org.asciidoctor.gradle.base.AsciidoctorAttributeProvider), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#attributeProvider(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#pfaccess$0(org.asciidoctor.gradle.base.AbstractImplementationEngineExtension), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#this$dist$invoke$2(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#this$dist$set$2(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#this$dist$get$2(java.lang.String), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getAttributeProviders(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#resetAttributesForLang(java.util.Map, java.lang.String), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#attributesForLang(java.util.Map, java.lang.String), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getSafeMode(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#setSafeMode(org.asciidoctor.gradle.base.SafeMode), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#setSafeMode(int), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#setSafeMode(java.lang.String), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getAttributesForLang(java.lang.String), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#attribute(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#attributes(java.util.Map), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#setAttributes(java.util.Map), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getAttributes(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getProjectOperations(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#invokeMethod(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getMetaClass(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#setMetaClass(groovy.lang.MetaClass), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getProperty(java.lang.String), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#setProperty(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#wait(long), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#wait(long, int), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#wait(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#equals(java.lang.Object), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#toString(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#hashCode(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#getClass(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#notify(), org.asciidoctor.gradle.base.AbstractImplementationEngineExtension#notifyAll()

- Field Detail
  - public static final String NAME
- Property Detail
  - List<Object> docExtensions
  - List<Pattern> fatalWarnings
  - String jrubyVersion
  - LogLevel logLevel
  - LogLevel logLevel
  - Map<String, Object> options
  - List<String> requires
  - String version
- Constructor Detail
  - @SuppressWarnings(value: ThisReferenceEscapesConstructor) AsciidoctorJExtension(Project project)
    
    Attach extension to a project.
    Parameters:
    project
  - @SuppressWarnings(value: ThisReferenceEscapesConstructor) AsciidoctorJExtension(Task task)
    
    Attach extension to a task.
    Parameters:
    task
- Method Detail
  - void docExtensions(groovy.lang.Closure<?>[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    If you use this method, then Gradle JARs will be leaked on to the classpath. This might not be what you want.
    
    Parameters:
    Closures - of Asciidoctor Groovy DSL extensions.
    Since:
    4.0.0
  - void docExtensions(File[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    Parameters:
    Files - of Groovy code of Asciidoctor Groovy DSL extensions.
    Since:
    4.0.0
  - void docExtensions(String[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    Parameters:
    Strings - of Groovy code of Asciidoctor Groovy DSL extensions.
    Since:
    4.0.0
  - void docExtensions(Provider<?>[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    Parameters:
    Provider - to strings or files of Groovy code of Asciidoctor Groovy DSL extensions
    Since:
    4.0.0
  - void docExtensions(Dependency[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    THis method is specifically useful for project dependencies.
    
    Parameters:
    Dependencies - containing Asciidoctor extensions
    Since:
    4.0.0
  - void docExtensions(Project[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    THis method is specifically useful for project dependencies.
    
    Parameters:
    Dependencies - containing Asciidoctor extensions
    Since:
    4.0.0
  - void docExtensionsFromExternal(String[] exts)
    
    Defines extensions to be registered. The given parameters should either contain Asciidoctor Groovy DSL closures or files with content conforming to the Asciidoctor Groovy DSL.
    Parameters:
    External - dependency definitions using standard Gradle dependency notation.
    Since:
    4.0.0
  - void fatalWarnings(Object[] patterns)
    
    Adds additional message patterns for treating Asciidoctor log messages as errors.
    Parameters:
    patterns - Message patterns.
  - Configuration getConfiguration()
    
    Returns a runConfiguration of the configured AsciidoctorJ dependencies.
    Returns:
    Resolvable configuration.
  - List<Object> getDocExtensions()
    
    Return extensions to be registered. These extensionRegistry are not registered at this call. That action is left to the specific task at its execution time.
    Returns:
    All extensions that should be registered on a conversion.
    Since:
    2.2.0
  - List<Pattern> getFatalWarnings()
    
    Provide patterns for Asciidoctor messages that are treated as failures.
    Returns:
    Regex patterns that will be used to check Asciidoctor log messages.
  - String getJrubyVersion()
    
    The version of JRuby to use. If no version of JRuby is specified the one that is linked to AsciidoctorJ will be used.
    Returns:
    Version of JRuby to use or null to use the JRuby version that is linked to the specified version of AsciidoctorJ.
  - LogLevel getLogLevel()
    
    The level at which the AsciidoctorJ process should be logging.
    Returns:
    The currently configured log level. By default this is project.logging.level.
  - AsciidoctorJModules getModules()
    
    Additional AsciidoctorJ modules to be configured.
    Returns:
    Module definition object.
    Since:
    2.2.0
  - Map<String, Object> getOptions()
    
    Returns all of the Asciidoctor options.
    Returns:
    Map with all scalars converted to strings. items in containers are also converted to strings but the contianer stucture is maintained.
  - List<String> getRequires()
    
    Returns the set of Ruby modules to be included.
    Since:
    1.5.0
  - String getVersion()
    
    Version of AsciidoctorJ that should be used.
    Returns:
    Asciidoctor version
  - void loadJRubyResolutionStrategy(Configuration cfg)
    
    Loads a JRUBy resolution rule onto the given configuration.
    Parameters:
    cfg - Configuration.
    Since:
    4.0
  - Pattern missingIncludes()
    
    Returns a patterns suitable for detecting missing include files. This can be passed to fatalWarnings(Object ...)
    Returns:
    Missing include file pattern.
  - void modules(@groovy.lang.DelegatesTo(value: AsciidoctorJModules) groovy.lang.Closure cfg)
    
    Configure modules via a closure.
    Parameters:
    cfg - Configurating closure
    Since:
    2.2.0
  - void modules(Action<AsciidoctorJModules> cfg)
    
    Configure modules via an Action.
    Parameters:
    cfg - Configurating Action
    Since:
    2.2.0
  - void options(Map m)
    
    Add additional Asciidoctor options This can be set globally for all Asciidoctor tasks in a project. If this is set in a task it will use this options in the task in addition to any global options.
    Parameters:
    m - Map with new options
  - void requires(Object[] b)
    
    Appends new set of Ruby modules to be included.
    Parameters:
    b - One or more ruby modules to be included
  - void resolutionStrategy(Action<ResolutionStrategy> strategy)
    
    Adds rules to the resolution strategy for resolving asciidoctorj related dependencies
    Parameters:
    strategy - Additional resolution strategy. Takes a ResolutionStrategy as parameter.
  - void resolutionStrategy(@groovy.lang.DelegatesTo(value: ResolutionStrategy) groovy.lang.Closure strategy)
    
    Adds rules to the resolution strategy for resolving asciidoctorj related dependencies
    Parameters:
    strategy - Additional resolution strategy. Takes a ResolutionStrategy as parameter.
  - void setDocExtensions(Iterable<Object> newExtensions)
    
    Clears the existing list of extensions and replace with a new set. If this is declared on a task extension all extension from the global project extension will be ignored.
    Since:
    2.2.0
  - void setFatalWarnings(Iterable<Object> patterns)
    
    Provide patterns for Asciidoctor messages that are treated as failures. Clears any existing message patterns. If this method is called on a task extension, the patterns from the project extension will be ignored.
    Parameters:
    patterns
  - void setJrubyVersion(Object v)
    
    Set a version of JRuby to use. The version specified is not a guarantetd version, simply a minimum required version. If the version of asciidoctorj is dependent on a version later than the one specified here, then that would be used instead. In such cases iif the exact version needs to be forced then a resolution strategy needs to be provided via resolutionStrategy.
    Parameters:
    v - JRuby version
  - void setLogLevel(LogLevel logLevel)
    
    Set the level at which the AsciidoctorJ process should be logging.
    Parameters:
    logLevel - LogLevel to use
  - void setLogLevel(String logLevel)
    
    Set the level at which the AsciidoctorJ process should be logging.
    Parameters:
    logLevel - LogLevel to use
  - void setOptions(Map m)
    
    Apply a new set of Asciidoctor options, clearing any options previously set. This can be set globally for all Asciidoctor tasks in a project. If this is set in a task it will override the global options.
    Parameters:
    m - Map with new options
  - void setRequires(Object[] b)
    
    Applies a new set of Ruby modules to be included, clearing any previous set. If this is called on a task extension, the global project requires will be ignored.
    Parameters:
    b - One or more ruby modules to be included
  - void setVersion(Object v)
    
    Set a new version to use.
    Parameters:
    v - New version to be used. Can be of anything that be be resolved by org.ysb33r.grolifant.api.core.StringTools#stringize

Summary:
Field
Property
Constructor
Method

[Groovy] Class AsciidoctorJExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String NAME

Property Detail

List<Object> docExtensions

List<Pattern> fatalWarnings

String jrubyVersion

LogLevel logLevel

LogLevel logLevel

Map<String, Object> options

List<String> requires

String version

Constructor Detail

@SuppressWarnings(value: ThisReferenceEscapesConstructor) AsciidoctorJExtension(Project project)

@SuppressWarnings(value: ThisReferenceEscapesConstructor) AsciidoctorJExtension(Task task)

Method Detail

void docExtensions(groovy.lang.Closure<?>[] exts)

void docExtensions(File[] exts)

void docExtensions(String[] exts)

void docExtensions(Provider<?>[] exts)

void docExtensions(Dependency[] exts)

void docExtensions(Project[] exts)

void docExtensionsFromExternal(String[] exts)

void fatalWarnings(Object[] patterns)

Configuration getConfiguration()

List<Object> getDocExtensions()

List<Pattern> getFatalWarnings()

String getJrubyVersion()

LogLevel getLogLevel()

AsciidoctorJModules getModules()

Map<String, Object> getOptions()

List<String> getRequires()

String getVersion()

void loadJRubyResolutionStrategy(Configuration cfg)

Pattern missingIncludes()

void modules(@groovy.lang.DelegatesTo(value: AsciidoctorJModules) groovy.lang.Closure cfg)

void modules(Action<AsciidoctorJModules> cfg)

void options(Map m)

void requires(Object[] b)

void resolutionStrategy(Action<ResolutionStrategy> strategy)

void resolutionStrategy(@groovy.lang.DelegatesTo(value: ResolutionStrategy) groovy.lang.Closure strategy)

void setDocExtensions(Iterable<Object> newExtensions)

void setFatalWarnings(Iterable<Object> patterns)

void setJrubyVersion(Object v)

void setLogLevel(LogLevel logLevel)

void setLogLevel(String logLevel)

void setOptions(Map m)

void setRequires(Object[] b)

void setVersion(Object v)