AbstractAsciidoctorTask (asciidoctor-gradle-jvm 4.0.2 API)

org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask

All Implemented Interfaces and Traits:: org.asciidoctor.gradle.base.AsciidoctorTaskMethods

@groovy.transform.CompileStatic
@SuppressWarnings(value: MethodCount)
class AbstractAsciidoctorTask
extends org.ysb33r.grolifant.api.core.runnable.AbstractJvmModelExecTask<AsciidoctorJvmExecSpec, AsciidoctorWorkerParameters>
implements org.asciidoctor.gradle.base.AsciidoctorTaskMethods

Base class for all AsciidoctorJ tasks.

Authors:: Schalk W. Cronjé; Manuel Prinz

Since:: 2.0.0

Field Summary

Fields
Modifiers	Name	Description
`static org.ysb33r.grolifant.api.core.jvm.ExecutionMode`	`CLASSPATH`
`static org.asciidoctor.gradle.base.log.Severity`	`ERROR`
`static org.asciidoctor.gradle.base.log.Severity`	`FATAL`
`static org.asciidoctor.gradle.base.log.Severity`	`INFO`
`static org.ysb33r.grolifant.api.core.jvm.ExecutionMode`	`IN_PROCESS`
`static org.ysb33r.grolifant.api.core.jvm.ExecutionMode`	`JAVA_EXEC`
`static org.ysb33r.grolifant.api.core.jvm.ExecutionMode`	`OUT_OF_PROCESS`
`static org.asciidoctor.gradle.base.log.Severity`	`WARN`

Properties Summary

Properties
Type	Name and description
`Map<String, Object>`	`attributes`
`FileCollection`	`configurations`
`org.asciidoctor.gradle.base.log.Severity`	`failureLevel`
`Map<String, Object>`	`options`
`boolean`	`parallelMode`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`attributes(Map m)` Add additional asciidoctor options
	`void`	`configurations(Iterable<Object> configs)` Add additional configurations.
	`void`	`configurations(Object[] configs)` Add additional configurations.
	`void`	`exec()`
	`void`	`forkOptions(groovy.lang.Closure configurator)` Set fork options for JAVA_EXEC and OUT_OF_PROCESS modes.
	`void`	`forkOptions(Action<org.ysb33r.grolifant.api.core.jvm.JavaForkOptionsWithEnvProvider> configurator)` Set fork options for JAVA_EXEC and OUT_OF_PROCESS modes.
	`List<org.asciidoctor.gradle.base.AsciidoctorAttributeProvider>`	`getAttributeProviders()` Additional providers of attributes.
	`Map<String, Object>`	`getAttributes()` Returns all of the Asciidoctor options.
	`FileCollection`	`getConfigurations()` Returns all of the specified configurations as a collections of files.
	`org.asciidoctor.gradle.base.log.Severity`	`getFailureLevel()` Get the minimum logging level that will fail the task.
	`Map<String, Object>`	`getOptions()` Returns all of the Asciidoctor options.
	`Set<Configuration>`	`getReportableConfigurations()` Configurations for which dependencies should be reported.
	`void`	`options(Map m)` Add additional asciidoctor options
	`void`	`setAttributes(Map m)` Apply a new set of Asciidoctor options, clearing any options previously set.
	`void`	`setConfigurations(Iterable<Object> configs)` Override any existing configurations except the ones available via the `asciidoctorj` task extension.
	`void`	`setExecutionMode(org.ysb33r.grolifant.api.core.jvm.ExecutionMode em)` Sets the execution mode.
	`void`	`setExecutionMode(String s)`
	`void`	`setFailureLevel(org.asciidoctor.gradle.base.log.Severity severity)` Set the minimum logging level that will fail the task.
	`void`	`setFailureLevel(String severity)` Set the minimum logging level that will fail the task.
	`void`	`setInProcess(org.asciidoctor.gradle.base.process.ProcessMode mode)` Set how AsciidoctorJ should be run.
	`void`	`setInProcess(String mode)` Set how AsciidoctorJ should be run.
	`void`	`setOptions(Map m)` Apply a new set of Asciidoctor options, clearing any options previously set.
	`void`	`withGemJar(TaskProvider<Jar> gemJar)` Adds a Jar of GEMs to the classpath.
	`void`	`withGemJar(String taskName)` Adds a Jar of GEMs to the classpath.
	`void`	`withGemPath(Provider<File> gemPath, String builtBy)` Adds a directory to the classpath.

- Field Detail
  - public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode CLASSPATH
  - public static final org.asciidoctor.gradle.base.log.Severity ERROR
  - public static final org.asciidoctor.gradle.base.log.Severity FATAL
  - public static final org.asciidoctor.gradle.base.log.Severity INFO
  - public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode IN_PROCESS
  - public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode JAVA_EXEC
  - public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode OUT_OF_PROCESS
  - public static final org.asciidoctor.gradle.base.log.Severity WARN
- Property Detail
  - Map<String, Object> attributes
  - FileCollection configurations
  - org.asciidoctor.gradle.base.log.Severity failureLevel
  - Map<String, Object> options
  - @Internal boolean parallelMode
- Method Detail
  - void attributes(Map m)
    
    Add additional asciidoctor options If set here these options will be used in addition to any global Asciidoctor options. This is equivalent of using asciidoctorj.attributes.
    Parameters:
    m - Map with new options
  - void configurations(Iterable<Object> configs)
    
    Add additional configurations.
    Parameters:
    configs - Instances of Configuration or anything convertible to a string than can be used as a name of a runConfiguration.
  - void configurations(Object[] configs)
    
    Add additional configurations.
    Parameters:
    configs - Instances of Configuration or anything convertible to a string than can be used as a name of a runConfiguration.
  - @Override void exec()
  - @Deprecated void forkOptions(@groovy.lang.DelegatesTo(value: JavaForkOptionsWithEnvProvider) groovy.lang.Closure configurator)
    
    Set fork options for JAVA_EXEC and OUT_OF_PROCESS modes. These options are ignored if inProcess == IN_PROCESS.
    deprecated:
    Use jvm instead.
    
    Parameters:
    configurator - Closure that configures a JavaForkOptions instance.
  - @Deprecated void forkOptions(Action<org.ysb33r.grolifant.api.core.jvm.JavaForkOptionsWithEnvProvider> configurator)
    
    Set fork options for JAVA_EXEC and OUT_OF_PROCESS modes. These options are ignored if inProcess == IN_PROCESS.
    deprecated:
    Use jvm instead.
    
    Parameters:
    configurator - Action that configures a JavaForkOptions instance.
  - @Internal List<org.asciidoctor.gradle.base.AsciidoctorAttributeProvider> getAttributeProviders()
    
    Additional providers of attributes. NOTE: Attributes added via providers do no change the up-to-date status of the task. Providers are therefore useful to add attributes such as build time.
    Returns:
    List of attribute providers.
  - @Input Map<String, Object> getAttributes()
    
    Returns all of the Asciidoctor options. This is equivalent of using asciidoctorj.getAttributes
  - @Classpath @SuppressWarnings(value: Instanceof) FileCollection getConfigurations()
    
    Returns all of the specified configurations as a collections of files. If any docExtensions are dependencies then they will be included here too.
    Returns:
    FileCollection
  - @Internal org.asciidoctor.gradle.base.log.Severity getFailureLevel()
    
    Get the minimum logging level that will fail the task. Valid options are FATAL, ERROR or WARN or INFO. The default mode is FATAL.
  - @Input Map<String, Object> getOptions()
    
    Returns all of the Asciidoctor options. This is equivalent of using asciidoctorj.getOptions
  - @Override Set<Configuration> getReportableConfigurations()
    
    Configurations for which dependencies should be reported.
    Returns:
    Set of configurations. Can be empty, but never null.
    Since:
    2.3.0
  - void options(Map m)
    
    Add additional asciidoctor options If set here these options will be used in addition to any global Asciidoctor options. This is equivalent of using asciidoctorj.options.
    Parameters:
    m - Map with new options
  - void setAttributes(Map m)
    
    Apply a new set of Asciidoctor options, clearing any options previously set. If set here all global Asciidoctor options are ignored within this task. This is equivalent of using asciidoctorj.setAttributes.
    Parameters:
    m - Map with new options
  - void setConfigurations(Iterable<Object> configs)
    
    Override any existing configurations except the ones available via the asciidoctorj task extension.
    Parameters:
    configs
  - @Override void setExecutionMode(org.ysb33r.grolifant.api.core.jvm.ExecutionMode em)
    
    Sets the execution mode.
    This allows for JVM tasks to be executed either on a worker queue inside the JVM using an isolated classpath, ouside the JVM in a separate process, OR using a classic javaexec.
    If nothing is set, the default is org.ysb33r.grolifant.api.core.jvm.ExecutionMode#JAVA_EXEC.
    Parameters:
    em - Execution mode.
    Throws:
    UnsupportedConfigurationException is mode is illegal within context.
  - void setExecutionMode(String s)
  - void setFailureLevel(org.asciidoctor.gradle.base.log.Severity severity)
    
    Set the minimum logging level that will fail the task.
    Parameters:
    severity - FATAL, ERROR or WARN or INFO.
  - void setFailureLevel(String severity)
    
    Set the minimum logging level that will fail the task.
    Parameters:
    severity - Case-insensitive string from of FATAL, ERROR or WARN or INFO.
  - @Deprecated void setInProcess(org.asciidoctor.gradle.base.process.ProcessMode mode)
    
    Set how AsciidoctorJ should be run.
    deprecated:
    Use setExecutionMode instead.
    
    Parameters:
    mode - IN_PROCESS, OUT_OF_PROCESS or JAVA_EXEC.
  - @Deprecated void setInProcess(String mode)
    
    Set how AsciidoctorJ should be run.
    deprecated:
    Use setExecutionMode instead.
    
    Parameters:
    mode - Case-insensitive string from of IN_PROCESS, OUT_OF_PROCESS or JAVA_EXEC.
    Since:
    3.0
  - void setOptions(Map m)
    
    Apply a new set of Asciidoctor options, clearing any options previously set. If set here all global Asciidoctor options are ignored within this task. This is equivalent of using asciidoctorj.setOptions.
    Parameters:
    m - Map with new options
  - void withGemJar(TaskProvider<Jar> gemJar)
    
    Adds a Jar of GEMs to the classpath.
    Parameters:
    gemJar - Provider to a Jar task which contain GEMs
    Since:
    4.0
  - void withGemJar(String taskName)
    
    Adds a Jar of GEMs to the classpath.
    Parameters:
    gemJar - name of a Jar task which contain GEMs.
    Since:
    4.0
  - void withGemPath(Provider<File> gemPath, String builtBy)
    
    Adds a directory to the classpath. THe directory will contain unpacked GEMs.
    Parameters:
    gemPath - A provider to a directory containing unpakcing GEMs.
    builtBy - THe name of the task that prepares this directory.
    Since:
    4.0

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Groovy] Class AbstractAsciidoctorTask

Field Summary

Properties Summary

Methods Summary

Field Detail

public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode CLASSPATH

public static final org.asciidoctor.gradle.base.log.Severity ERROR

public static final org.asciidoctor.gradle.base.log.Severity FATAL

public static final org.asciidoctor.gradle.base.log.Severity INFO

public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode IN_PROCESS

public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode JAVA_EXEC

public static final org.ysb33r.grolifant.api.core.jvm.ExecutionMode OUT_OF_PROCESS

public static final org.asciidoctor.gradle.base.log.Severity WARN

Property Detail

Map<String, Object> attributes

FileCollection configurations

org.asciidoctor.gradle.base.log.Severity failureLevel

Map<String, Object> options

@Internal boolean parallelMode

Method Detail

void attributes(Map m)

void configurations(Iterable<Object> configs)

void configurations(Object[] configs)

@Override void exec()

@Deprecated void forkOptions(@groovy.lang.DelegatesTo(value: JavaForkOptionsWithEnvProvider) groovy.lang.Closure configurator)

@Deprecated void forkOptions(Action<org.ysb33r.grolifant.api.core.jvm.JavaForkOptionsWithEnvProvider> configurator)

@Internal List<org.asciidoctor.gradle.base.AsciidoctorAttributeProvider> getAttributeProviders()

@Input Map<String, Object> getAttributes()

@Classpath @SuppressWarnings(value: Instanceof) FileCollection getConfigurations()

@Internal org.asciidoctor.gradle.base.log.Severity getFailureLevel()

@Input Map<String, Object> getOptions()

@Override Set<Configuration> getReportableConfigurations()

void options(Map m)

void setAttributes(Map m)

void setConfigurations(Iterable<Object> configs)

@Override void setExecutionMode(org.ysb33r.grolifant.api.core.jvm.ExecutionMode em)

void setExecutionMode(String s)

void setFailureLevel(org.asciidoctor.gradle.base.log.Severity severity)

void setFailureLevel(String severity)

@Deprecated void setInProcess(org.asciidoctor.gradle.base.process.ProcessMode mode)

@Deprecated void setInProcess(String mode)

void setOptions(Map m)

void withGemJar(TaskProvider<Jar> gemJar)

void withGemJar(String taskName)

void withGemPath(Provider<File> gemPath, String builtBy)