AsciidoctorTaskFileOperations (asciidoctor-gradle-base 5.0.2 API)

All Known Subinterfaces:

AsciidoctorTaskMethods
```
public interface AsciidoctorTaskFileOperations
```
The standard methods all Asciidoctor conversion tasks will offer.

Since:

4.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clearSecondarySources()` Clears any of the existing secondary soruces patterns.
`void`	`clearSources()` Clears existing sources patterns.
`java.util.Set<java.io.File>`	`getBackendOutputDirectories()` Returns a list of all output directories by backend.
`org.gradle.api.file.CopySpec`	`getDefaultResourceCopySpec(java.util.Optional<java.lang.String> lang)` The default CopySpec that will be used if `resources` was never called By default, anything below `$sourceDir/images` will be included.
`java.lang.String`	`getEngineName()` The name of the Asciidoctor engine implementation.
`org.gradle.api.provider.Provider<org.gradle.api.tasks.util.PatternSet>`	`getIntermediateArtifactPatternProvider()` A provider of patterns identifying intermediate artifacts.
`default java.io.File`	`getIntermediateWorkDir()` The directory that will be the intermediate directory should one be required.
`org.gradle.api.provider.Provider<java.io.File>`	`getIntermediateWorkDirProvider()`
`org.gradle.api.file.CopySpec`	`getLanguageResourceCopySpec(java.lang.String lang)` Returns the copy specification for the resources of a specific language.
`java.util.List<java.lang.String>`	`getLanguages()` Obtain List of languages the sources documents are written in.
`boolean`	`getLogDocuments()` Logs documents as they are converted
`default java.io.File`	`getOutputDir()` Returns the current toplevel output directory
`org.gradle.api.file.DirectoryProperty`	`getOutputDirProperty()` Returns the current toplevel output directory as a property object.
`org.gradle.api.file.CopySpec`	`getResourceCopySpec(java.util.Optional<java.lang.String> lang)` Gets the CopySpec for additional resources.
`org.gradle.api.file.FileTree`	`getSecondarySourceFileTree()` Returns a FileTree containing all secondary source documents.
`default java.io.File`	`getSourceDir()` Returns the parent directory for Asciidoctor source.
`org.gradle.api.file.DirectoryProperty`	`getSourceDirProperty()` Returns the parent directory for Asciidoctor source as a property object.
`org.gradle.api.file.FileTree`	`getSourceFileTree()` Returns a FileTree containing all source documents If a filter with `sources(groovy.lang.Closure<?>)` was never set then all asciidoc source files below `setSourceDir(java.lang.Object)` will be included.
`java.util.Map<java.lang.String,?>`	`getTaskSpecificDefaultAttributes(java.io.File workingSourceDir)` A task may add some default attributes.
`boolean`	`hasIntermediateWorkDir()` Checks whether an intermediate workdir is required.
`void`	`languages(java.lang.Iterable<java.lang.String> langs)` Add to list of languages to process.
`void`	`languages(java.lang.String... langs)` Add to list of languages to process.
`void`	`resources(org.gradle.api.Action<? super org.gradle.api.file.CopySpec> cfg)` Add to the CopySpec for extra files.
`void`	`resources(groovy.lang.Closure cfg)` Add to the CopySpec for extra files.
`void`	`resources(java.lang.String lang, org.gradle.api.Action<? super org.gradle.api.file.CopySpec> cfg)` Add to the CopySpec for extra files.
`void`	`resources(java.lang.String lang, groovy.lang.Closure cfg)` Add to the CopySpec for extra files.
`void`	`secondarySources(org.gradle.api.Action<? super org.gradle.api.tasks.util.PatternSet> cfg)` Configures sources.
`void`	`secondarySources(groovy.lang.Closure<?> cfg)` Configures secondary sources.
`void`	`setLanguages(java.lang.Iterable<java.lang.String> langs)` Reset current list of languages and replace with a new set.
`void`	`setLogDocuments(boolean mode)` Whether to log documents as they are being converted.
`void`	`setOutputDir(java.lang.Object f)` Sets the new Asciidoctor parent output directory.
`void`	`setSourceDir(java.lang.Object f)` Sets the new Asciidoctor parent source directory.
`void`	`sourceDir(java.lang.Object f)` Sets the new Asciidoctor parent source directory in a declarative style.
`void`	`sources(org.gradle.api.Action<? super org.gradle.api.tasks.util.PatternSet> cfg)` Configures sources.
`void`	`sources(groovy.lang.Closure<?> cfg)` Configures sources.
`void`	`sources(java.lang.String... includePatterns)` Include source patterns.
`void`	`useIntermediateWorkDir()` Some extensions such as `ditaa` creates images in the source directory.
`void`	`withIntermediateArtifacts(org.gradle.api.Action<org.gradle.api.tasks.util.PatternSet> cfg)` Additional artifacts created by Asciidoctor that might require copying.
`void`	`withIntermediateArtifacts(groovy.lang.Closure cfg)` The document conversion might generate additional artifacts that could require copying to the final destination.

- Method Detail
  - getEngineName
```
@Internal
java.lang.String getEngineName()
```
    The name of the Asciidoctor engine implementation.
    
    Returns:
    
    Engine name.
  - getLogDocuments
```
@Console
boolean getLogDocuments()
```
    Logs documents as they are converted
    
    Returns:
    
    true if documents should be logged.
  - setLogDocuments
```
void setLogDocuments(boolean mode)
```
    Whether to log documents as they are being converted.
    
    Parameters:
    
    mode - Set true in order to log documents.
  - setSourceDir
```
void setSourceDir(java.lang.Object f)
```
    Sets the new Asciidoctor parent source directory.
    
    Parameters:
    
    f - Any object convertible with project.file.
  - sourceDir
```
void sourceDir(java.lang.Object f)
```
    Sets the new Asciidoctor parent source directory in a declarative style.
    
    Parameters:
    
    f - Any object convertible with project.file.
  - getSourceDir
```
@Internal
default java.io.File getSourceDir()
```
    Returns the parent directory for Asciidoctor source.
    
    Returns:
    
    Location of source directory.
  - getSourceDirProperty
```
@Internal
org.gradle.api.file.DirectoryProperty getSourceDirProperty()
```
    Returns the parent directory for Asciidoctor source as a property object.
    
    Returns:
    
    Source directory as a property.
  - getOutputDir
```
@OutputDirectory
default java.io.File getOutputDir()
```
    Returns the current toplevel output directory
    
    Returns:
    
    Output directory.
  - setOutputDir
```
void setOutputDir(java.lang.Object f)
```
    Sets the new Asciidoctor parent output directory.
    
    Parameters:
    
    f - An object convertible via project.file.
  - getOutputDirProperty
```
@Internal
org.gradle.api.file.DirectoryProperty getOutputDirProperty()
```
    Returns the current toplevel output directory as a property object.
    
    Returns:
    
    Output directory as a property.
  - sources
```
void sources(@DelegatesTo(value=org.gradle.api.tasks.util.PatternSet.class)
             groovy.lang.Closure<?> cfg)
```
    Configures sources.
    
    Parameters:
    
    cfg - Configuration closure. Is passed a PatternSet.
  - sources
```
void sources(org.gradle.api.Action<? super org.gradle.api.tasks.util.PatternSet> cfg)
```
    Configures sources.
    
    Parameters:
    
    cfg - Configuration Action. Is passed a PatternSet.
  - sources
```
void sources(java.lang.String... includePatterns)
```
    Include source patterns.
    
    Parameters:
    
    includePatterns - ANT-style patterns for sources to include
  - clearSources
```
void clearSources()
```
    Clears existing sources patterns.
  - clearSecondarySources
```
void clearSecondarySources()
```
    Clears any of the existing secondary soruces patterns. This should be used if none of the default patterns should be monitored.
  - secondarySources
```
void secondarySources(@DelegatesTo(value=org.gradle.api.tasks.util.PatternSet.class)
                      groovy.lang.Closure<?> cfg)
```
    Configures secondary sources.
    
    Parameters:
    
    cfg - Configuration closure. Is passed a PatternSet.
  - secondarySources
```
void secondarySources(org.gradle.api.Action<? super org.gradle.api.tasks.util.PatternSet> cfg)
```
    Configures sources.
    
    Parameters:
    
    cfg - Configuration Action. Is passed a PatternSet.
  - getIntermediateArtifactPatternProvider
```
@Internal
org.gradle.api.provider.Provider<org.gradle.api.tasks.util.PatternSet> getIntermediateArtifactPatternProvider()
```
    A provider of patterns identifying intermediate artifacts.
    
    Returns:
    
    Provider to a PatternSet. Can be empty.
  - getLanguageResourceCopySpec
```
org.gradle.api.file.CopySpec getLanguageResourceCopySpec(java.lang.String lang)
```
    Returns the copy specification for the resources of a specific language.
    
    Parameters:
    
    lang - Language
    
    Returns:
    
    Copy specification. Can be null.
  - getResourceCopySpec
```
org.gradle.api.file.CopySpec getResourceCopySpec(java.util.Optional<java.lang.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.
  - getDefaultResourceCopySpec
```
org.gradle.api.file.CopySpec getDefaultResourceCopySpec(java.util.Optional<java.lang.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.
  - getSourceFileTree
```
@Internal
org.gradle.api.file.FileTree getSourceFileTree()
```
    Returns a FileTree containing all source documents If a filter with sources(groovy.lang.Closure<?>) was never set then all asciidoc source files below setSourceDir(java.lang.Object) will be included. If multiple languages are used, all * language secondary source sets are included.
    
    Returns:
    
    Applicable source trees.
  - getSecondarySourceFileTree
```
@Internal
org.gradle.api.file.FileTree getSecondarySourceFileTree()
```
    Returns a FileTree containing all secondary source documents. If a filter with secondarySources(groovy.lang.Closure<?>) was never set then all asciidoc source files below setSourceDir(java.lang.Object) will be included. If multiple languages are used, all language secondary source sets are included.
    
    Returns:
    
    Collection of secondary source files
  - resources
```
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
  - resources
```
void resources(org.gradle.api.Action<? super org.gradle.api.file.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
  - resources
```
void resources(java.lang.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.
  - resources
```
void resources(java.lang.String lang,
               org.gradle.api.Action<? super org.gradle.api.file.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
  - useIntermediateWorkDir
```
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
  - hasIntermediateWorkDir
```
boolean hasIntermediateWorkDir()
```
    Checks whether an intermediate workdir is required.
    
    Returns:
    
    true is there is an intermediate working directory.
  - withIntermediateArtifacts
```
void withIntermediateArtifacts(@DelegatesTo(value=org.gradle.api.tasks.util.PatternSet.class)
                               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().
    
    Parameters:
    
    cfg - Configures a PatternSet with a base directory of the intermediate working directory.
  - withIntermediateArtifacts
```
void withIntermediateArtifacts(org.gradle.api.Action<org.gradle.api.tasks.util.PatternSet> cfg)
```
    Additional artifacts created by Asciidoctor that might require copying.
    See withIntermediateArtifacts(Closure cfg).
    
    Parameters:
    
    cfg - Action that configures a PatternSet.
  - getIntermediateWorkDir
```
@Internal
default java.io.File getIntermediateWorkDir()
```
    The directory that will be the intermediate directory should one be required.
    
    Returns:
    
    Intermediate working directory
  - getIntermediateWorkDirProvider
```
@Internal
org.gradle.api.provider.Provider<java.io.File> getIntermediateWorkDirProvider()
```
  - getBackendOutputDirectories
```
@OutputDirectories
java.util.Set<java.io.File> getBackendOutputDirectories()
```
    Returns a list of all output directories by backend.
    
    Returns:
    
    Backend output directories.
  - getLanguages
```
@Input
java.util.List<java.lang.String> getLanguages()
```
    Obtain List of languages the sources documents are written in.
    
    Returns:
    
    List of languages. Can be empty, but never null.
  - setLanguages
```
void setLanguages(java.lang.Iterable<java.lang.String> langs)
```
    Reset current list of languages and replace with a new set.
    
    Parameters:
    
    langs - List of new languages
  - languages
```
void languages(java.lang.Iterable<java.lang.String> langs)
```
    Add to list of languages to process.
    
    Parameters:
    
    langs - List of additional languages
  - languages
```
void languages(java.lang.String... langs)
```
    Add to list of languages to process.
    
    Parameters:
    
    langs - List of additional languages
  - getTaskSpecificDefaultAttributes
```
java.util.Map<java.lang.String,?> getTaskSpecificDefaultAttributes(java.io.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.

Interface AsciidoctorTaskFileOperations

Method Summary

Method Detail

getEngineName

getLogDocuments

setLogDocuments

setSourceDir

sourceDir

getSourceDir

getSourceDirProperty

getOutputDir

setOutputDir

getOutputDirProperty

sources

sources

sources

clearSources

clearSecondarySources

secondarySources

secondarySources

getIntermediateArtifactPatternProvider

getLanguageResourceCopySpec

getResourceCopySpec

getDefaultResourceCopySpec

getSourceFileTree

getSecondarySourceFileTree

resources

resources

resources

resources

useIntermediateWorkDir

hasIntermediateWorkDir

withIntermediateArtifacts

withIntermediateArtifacts

getIntermediateWorkDir

getIntermediateWorkDirProvider

getBackendOutputDirectories

getLanguages

setLanguages

languages

languages

getTaskSpecificDefaultAttributes