AbstractAsciidoctorBaseTask (asciidoctor-gradle-base 4.0.4 API)

org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask

All Implemented Interfaces and Traits:

AsciidoctorTaskMethods
```
@groovy.transform.CompileStatic
@SuppressWarnings(value: [MethodCount, ClassSize])
abstract class AbstractAsciidoctorBaseTask
extends DefaultTask
implements AsciidoctorTaskMethods
```
Abstract base task for Asciidoctor that can be shared between AsciidoctorJ and Asciidoctor.js.
Authors:
Schalk W. Cronjé
Lari Hotari
Gary Hale
Since:
3.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`AbstractAsciidoctorBaseTask.1`
`class`	`AbstractAsciidoctorBaseTask.2`

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`Map<String, Object>`	`attributes`
`List<String>`	`languages`
`boolean`	`logDocuments` Logs documents as they are converted
`File`	`outputDir`
`Object`	`sourceDir`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract void`	`attributes(Map<String, Object> m)` Shortcut method to add additional asciidoctor attributes.
	`void`	`clearSecondarySources()` Clears any of the existing secondary soruces patterns.
	`void`	`clearSources()` Clears existing sources patterns.
	`void`	`copyAllResources()` Copies all resources to the output directory.
	`void`	`copyNoResources()` Do not copy any resources to the output directory.
	`void`	`copyResourcesOnlyIf(String[] backendNames)` Copy resources to the output directory only if the backend names matches any of the specified names.
	`abstract List<AsciidoctorAttributeProvider>`	`getAttributeProviders()` Shortcut method to access additional providers of attributes.
	`abstract Map<String, Object>`	`getAttributes()` Shortcut method for obtaining attributes.
	`Set<File>`	`getBackendOutputDirectories()` Returns a list of all output directories by backend
	`Optional<List<String>>`	`getCopyResourcesForBackends()` List of backends for which to copy resources.
	`CopySpec`	`getDefaultResourceCopySpec(Optional<String> lang)` The default CopySpec that will be used if `resources` was never called
	`Provider<PatternSet>`	`getIntermediateArtifactPatternProvider()` A provider of patterns identifying intermediate artifacts.
	`File`	`getIntermediateWorkDir()` The directory that will be the intermediate directory should one be required.
	`Provider<File>`	`getIntermediateWorkDirProvider()`
	`CopySpec`	`getLanguageResourceCopySpec(String lang)` Returns the copy specification for the resources of a specific language.
	`List<String>`	`getLanguages()` Obtain List of languages the sources documents are written in.
	`File`	`getOutputDir()` Returns the current toplevel output directory
	`DirectoryProperty`	`getOutputDirProperty()` Returns the current toplevel output directory as a property object.
	`abstract Set<Configuration>`	`getReportableConfigurations()` Configurations for which dependencies should be reported.
	`CopySpec`	`getResourceCopySpec(Optional<String> lang)` Gets the CopySpec for additional resources.
	`FileTree`	`getSecondarySourceFileTree()` Returns a FileTree containing all of the secondary source documents.
	`File`	`getSourceDir()` Returns the parent directory for Asciidoctor source.
	`DirectoryProperty`	`getSourceDirProperty()` Returns the parent directory for Asciidoctor source as a property object.
	`FileTree`	`getSourceFileTree()` Returns a FileTree containing all of the source documents
	`Map<String, Object>`	`getTaskSpecificDefaultAttributes(File workingSourceDir)` A task may add some default attributes.
	`boolean`	`hasIntermediateWorkDir()` Checks whether an intermediate workdir is required.
	`boolean`	`isBaseDirConfigured()` Checks whether an explicit strategy has been set for base directory.
	`void`	`languages(Iterable<String> langs)` Add to list of languages to process.
	`void`	`languages(String[] langs)` Add to list of languages to process.
	`Workspace`	`prepareWorkspace()` Prepares a workspace prior to conversion.
	`Workspace`	`prepareWorkspace(String language)` Prepares a workspace for a specific language prior to conversion.
	`void`	`resources(groovy.lang.Closure cfg)` Add to the CopySpec for extra files.
	`void`	`resources(Action<? super CopySpec> cfg)` Add to the CopySpec for extra files.
	`void`	`resources(String lang, groovy.lang.Closure cfg)` Add to the CopySpec for extra files.
	`void`	`resources(String lang, Action<? super CopySpec> cfg)` Add to the CopySpec for extra files.
	`void`	`secondarySources(groovy.lang.Closure cfg)` Configures secondary sources.
	`void`	`secondarySources(Action<? super PatternSet> cfg)` Configures sources.
	`abstract void`	`setAttributes(Map<String, Object> m)` Shortcut method to apply a new set of Asciidoctor attributes, clearing any attributes previously set.
	`void`	`setLanguages(Iterable<String> langs)` Reset current list of languages and replace with a new set.
	`void`	`setOutputDir(Object f)` Sets the new Asciidoctor parent output directory.
	`void`	`setSourceDir(Object f)` Sets the new Asciidoctor parent source directory.
	`void`	`sourceDir(Object f)` Sets the new Asciidoctor parent source directory in a declarative style.
	`void`	`sources(groovy.lang.Closure cfg)` Configures sources.
	`void`	`sources(Action<? super PatternSet> cfg)` Configures sources.
	`void`	`sources(String[] includePatterns)` Include source patterns.
	`void`	`useIntermediateWorkDir()` Some extensions such as `ditaa` creates images in the source directory.
	`void`	`withIntermediateArtifacts(groovy.lang.Closure cfg)` The document conversion might generate additional artifacts that could require copying to the final destination.
	`void`	`withIntermediateArtifacts(Action<PatternSet> cfg)` Additional artifacts created by Asciidoctor that might require copying.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultTask`	property, getGroup, getAnt, setGroup, doFirst, doFirst, doFirst, onlyIf, onlyIf, onlyIf, doLast, doLast, doLast, mustRunAfter, shouldRunAfter, getFinalizedBy, getMustRunAfter, getShouldRunAfter, finalizedBy, getTaskDependencies, getTaskDependencies, setActions, getDependsOn, setDependsOn, dependsOn, setOnlyIf, setOnlyIf, setOnlyIf, setDidWork, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, setMustRunAfter, setFinalizedBy, setShouldRunAfter, usesService, setDescription, getInputs, getInputs, getProject, hasProperty, getLogging, getDidWork, configure, configure, setEnabled, getDescription, setProperty, compareTo, compareTo, getName, getActions, getState, getState, getPath, getExtensions, getLogger, getTimeout, isCompatibleWithConfigurationCache, notCompatibleWithConfigurationCache, prependParallelSafeAction, injectIntoNewInstance, getTaskActions, hasTaskActions, getReasonNotToTrackState, getImpliesSubProjects, setImpliesSubProjects, getTemporaryDirFactory, appendParallelSafeAction, isHasCustomActions, getRequiredServices, getOnlyIf, getAsDynamicObject, getSharedResources, getLifecycleDependencies, getLifecycleDependencies, doNotTrackState, getTaskIdentity, getIdentityPath, getStandardOutputCapture, getConvention, getReasonTaskIsIncompatibleWithConfigurationCache, isEnabled, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

- Property Detail
  - Map<String, Object> attributes
  - List<String> languages
  - @Console boolean logDocuments
    
    Logs documents as they are converted
  - File outputDir
  - Object sourceDir
- Method Detail
  - abstract void attributes(Map<String, Object> m)
    
    Shortcut method to add additional asciidoctor attributes. In most implementations this will just access the attributes method on the appropriate task extension derived from AbstractImplementationEngineExtension
    Parameters:
    m - Map with new options
  - void clearSecondarySources()
    
    Clears any of the existing secondary soruces patterns. This should be used if none of the default patterns should be monitored.
  - void clearSources()
    
    Clears existing sources patterns.
  - void copyAllResources()
    
    Copies all resources to the output directory. Some backends (such as html5) require all resources to be copied to the output directory. This is the default behaviour for this task.
  - void copyNoResources()
    
    Do not copy any resources to the output directory. Some backends (such as pdf) process all resources in place.
  - void copyResourcesOnlyIf(String[] backendNames)
    
    Copy resources to the output directory only if the backend names matches any of the specified names.
    Parameters:
    backendNames - List of names for which resources should be copied.
  - @Internal abstract List<AsciidoctorAttributeProvider> getAttributeProviders()
    
    Shortcut method to access additional providers of attributes. In most implementations this will just access the getAttributeProviders method on the appropriate task extension derived from AbstractImplementationEngineExtension
    Returns:
    List of attribute providers.
  - @Input abstract Map<String, Object> getAttributes()
    
    Shortcut method for obtaining attributes. In most implementations this will just access the getAttributes method on the appropriate task extension derived from AbstractImplementationEngineExtension
    Returns:
    Access to attributes hashmap
  - @OutputDirectories Set<File> getBackendOutputDirectories()
    
    Returns a list of all output directories by backend
    Since:
    1.5.1
  - @Internal Optional<List<String>> getCopyResourcesForBackends()
    
    List of backends for which to copy resources.
    Returns:
    List of backends. Can be null.
  - @groovy.transform.CompileDynamic CopySpec getDefaultResourceCopySpec(Optional<String> lang)
    
    The default CopySpec that will be used if resources was never called By default anything below $sourceDir/images will be included.
    Parameters:
    lang - Language to use. Can be empty (not null) when not to use a language.
    Returns:
    ACopySpec. Never null.
  - @Override Provider<PatternSet> getIntermediateArtifactPatternProvider()
    
    A provider of patterns identifying intermediate artifacts.
    Returns:
    Provider to a PatternSet. Can be empty.
  - @Internal File getIntermediateWorkDir()
    
    The directory that will be the intermediate directory should one be required.
    Returns:
    Intermediate working directory
    Since:
    2.2.0
  - @Override Provider<File> getIntermediateWorkDirProvider()
  - @Override CopySpec getLanguageResourceCopySpec(String lang)
    
    Returns the copy specification for the resources of a specific language.
    Parameters:
    lang - Language
    Returns:
    Copy specification. Can be null.
  - @Input List<String> getLanguages()
    
    Obtain List of languages the sources documents are written in.
    Returns:
    List of languages. Can be empty, but never null.
    Since:
    3.0.0
  - @OutputDirectory File getOutputDir()
    
    Returns the current toplevel output directory
  - @Internal DirectoryProperty getOutputDirProperty()
    
    Returns the current toplevel output directory as a property object.
  - @Internal abstract Set<Configuration> getReportableConfigurations()
    
    Configurations for which dependencies should be reported.
    Returns:
    Set of configurations. Can be empty, but never null.
    Since:
    2.3.0 (Moved from org.asciidoctor.gradle.jvm)
  - @Override CopySpec getResourceCopySpec(Optional<String> lang)
    
    Gets the CopySpec for additional resources. If resources was never called, it will return a default CopySpec otherwise it will return the one built up via successive calls to resources
    Parameters:
    lang - Language to to apply to or empty for no-language support.
    Returns:
    ACopySpec. Never null.
  - @Internal FileTree getSecondarySourceFileTree()
    
    Returns a FileTree containing all of the secondary source documents. If a filter with secondarySources was never set then all asciidoc source files below setSourceDir will be included. If multiple languages are used all of the language secondary source sets be will included.
    Returns:
    Collection of secondary source files
  - @Internal File getSourceDir()
    
    Returns the parent directory for Asciidoctor source.
  - @Internal DirectoryProperty getSourceDirProperty()
    
    Returns the parent directory for Asciidoctor source as a property object.
  - @Internal FileTree getSourceFileTree()
    
    Returns a FileTree containing all of the source documents If a filter with sources was never set then all asciidoc source files below setSourceDir will be included. If multiple languages are used all of the language source sets be will included.
    Returns:
    Applicable source trees.
    Since:
    1.5.1
  - Map<String, Object> getTaskSpecificDefaultAttributes(File workingSourceDir)
    
    A task may add some default attributes. If the user specifies any of these attributes, then those attributes will not be utilised. The default implementation will add includedir, revnumber, gradle-project-group, gradle-project-name
    Parameters:
    workingSourceDir - Directory where source files are located.
    Returns:
    A collection of default attributes.
  - @Override boolean hasIntermediateWorkDir()
    
    Checks whether an intermediate workdir is required.
    Returns:
    true is there is an intermediate working directory.
  - @Internal boolean isBaseDirConfigured()
    
    Checks whether an explicit strategy has been set for base directory.
    Returns:
    true if a strategy has been configured.
  - void languages(Iterable<String> langs)
    
    Add to list of languages to process.
    Parameters:
    langs - List of additional languages
    Since:
    3.0.0
  - void languages(String[] langs)
    
    Add to list of languages to process.
    Parameters:
    langs - List of additional languages
    Since:
    3.0.0
  - Workspace prepareWorkspace()
    
    Prepares a workspace prior to conversion.
    Returns:
    A presentation of the working source directory and the source tree.
  - Workspace prepareWorkspace(String language)
    
    Prepares a workspace for a specific language prior to conversion.
    Parameters:
    language - Language to prepare workspace for.
    Returns:
    A presentation of the working source directory and the source tree.
  - void resources(groovy.lang.Closure cfg)
    
    Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend
    Parameters:
    cfg - CopySpec runConfiguration closure
    Since:
    1.5.1
  - void resources(Action<? super CopySpec> cfg)
    
    Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend
    Parameters:
    cfg - CopySpec runConfiguration Action
  - void resources(String lang, groovy.lang.Closure cfg)
    
    Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend If not languages are set. these resources will be ignored.
    Parameters:
    cfg - CopySpec runConfiguration closure
    lang - Language to which these resources will be applied to.
    Since:
    3.0.0
  - void resources(String lang, Action<? super CopySpec> cfg)
    
    Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend If not languages are set. these resources will be ignored.
    Parameters:
    cfg - CopySpec runConfiguration Action
    lang - Language to which these resources will be applied to.
    Since:
    3.0.0
  - @groovy.transform.CompileDynamic void secondarySources(groovy.lang.Closure cfg)
    
    Configures secondary sources.
    Parameters:
    cfg - Configuration closure. Is passed a PatternSet.
  - void secondarySources(Action<? super PatternSet> cfg)
    
    Configures sources.
    Parameters:
    cfg - Configuration Action. Is passed a PatternSet.
  - abstract void setAttributes(Map<String, Object> m)
    
    Shortcut method to apply a new set of Asciidoctor attributes, clearing any attributes previously set. In most implementations this will just access the setAttributes method on the appropriate task extension derived from AbstractImplementationEngineExtension
    Parameters:
    m - Map with new options
  - void setLanguages(Iterable<String> langs)
    
    Reset current list of languages and replace with a new set.
    Parameters:
    langs - List of new languages
    Since:
    3.0.0
  - void setOutputDir(Object f)
    
    Sets the new Asciidoctor parent output directory.
    Parameters:
    f - An object convertible via project.file
  - void setSourceDir(Object f)
    
    Sets the new Asciidoctor parent source directory.
    Parameters:
    f - Any object convertible with project.file.
  - void sourceDir(Object f)
    
    Sets the new Asciidoctor parent source directory in a declarative style.
    Parameters:
    f - Any object convertible with project.file.
    Since:
    3.0
  - void sources(groovy.lang.Closure cfg)
    
    Configures sources.
    Parameters:
    cfg - Configuration closure. Is passed a PatternSet.
  - void sources(Action<? super PatternSet> cfg)
    
    Configures sources.
    Parameters:
    cfg - Configuration Action. Is passed a PatternSet.
  - void sources(String[] includePatterns)
    
    Include source patterns.
    Parameters:
    includePatterns - ANT-style patterns for sources to include
  - void useIntermediateWorkDir()
    
    Some extensions such as ditaa creates images in the source directory. Use this setting to copy all sources and resources to an intermediate work directory before processing starts. This will keep the source directory pristine
  - void withIntermediateArtifacts(@groovy.lang.DelegatesTo(value: PatternSet) groovy.lang.Closure cfg)
    
    The document conversion might generate additional artifacts that could require copying to the final destination. An example is use of ditaa diagram blocks. These artifacts can be specified in this block. Use of the option implies useIntermediateWorkDir. If copyNoResources is set or copyResourcesOnlyIf(String ...) does not match the backend, no copy will occur.
    Parameters:
    cfg - Configures a PatternSet with a base directory of the intermediate working directory.
  - void withIntermediateArtifacts(Action<PatternSet> cfg)
    
    Additional artifacts created by Asciidoctor that might require copying.
    Parameters:
    cfg - Action that configures a PatternSet.
    See Also:
    withIntermediateArtifacts(Closure cfg)

Summary:
Nested
Property
Method

| Detail:
Property
Method

[Groovy] Class AbstractAsciidoctorBaseTask

Nested Class Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

Map<String, Object> attributes

List<String> languages

@Console boolean logDocuments

File outputDir

Object sourceDir

Method Detail

abstract void attributes(Map<String, Object> m)

void clearSecondarySources()

void clearSources()

void copyAllResources()

void copyNoResources()

void copyResourcesOnlyIf(String[] backendNames)

@Internal abstract List<AsciidoctorAttributeProvider> getAttributeProviders()

@Input abstract Map<String, Object> getAttributes()

@OutputDirectories Set<File> getBackendOutputDirectories()

@Internal Optional<List<String>> getCopyResourcesForBackends()

@groovy.transform.CompileDynamic CopySpec getDefaultResourceCopySpec(Optional<String> lang)

@Override Provider<PatternSet> getIntermediateArtifactPatternProvider()

@Internal File getIntermediateWorkDir()

@Override Provider<File> getIntermediateWorkDirProvider()

@Override CopySpec getLanguageResourceCopySpec(String lang)

@Input List<String> getLanguages()

@OutputDirectory File getOutputDir()

@Internal DirectoryProperty getOutputDirProperty()

@Internal abstract Set<Configuration> getReportableConfigurations()

@Override CopySpec getResourceCopySpec(Optional<String> lang)

@Internal FileTree getSecondarySourceFileTree()

@Internal File getSourceDir()

@Internal DirectoryProperty getSourceDirProperty()

@Internal FileTree getSourceFileTree()

Map<String, Object> getTaskSpecificDefaultAttributes(File workingSourceDir)

@Override boolean hasIntermediateWorkDir()

@Internal boolean isBaseDirConfigured()

void languages(Iterable<String> langs)

void languages(String[] langs)

Workspace prepareWorkspace()

Workspace prepareWorkspace(String language)

void resources(groovy.lang.Closure cfg)

void resources(Action<? super CopySpec> cfg)

void resources(String lang, groovy.lang.Closure cfg)

void resources(String lang, Action<? super CopySpec> cfg)

@groovy.transform.CompileDynamic void secondarySources(groovy.lang.Closure cfg)

void secondarySources(Action<? super PatternSet> cfg)

abstract void setAttributes(Map<String, Object> m)

void setLanguages(Iterable<String> langs)

void setOutputDir(Object f)

void setSourceDir(Object f)

void sourceDir(Object f)

void sources(groovy.lang.Closure cfg)

void sources(Action<? super PatternSet> cfg)

void sources(String[] includePatterns)

void useIntermediateWorkDir()

void withIntermediateArtifacts(@groovy.lang.DelegatesTo(value: PatternSet) groovy.lang.Closure cfg)

void withIntermediateArtifacts(Action<PatternSet> cfg)