DefaultAsciidoctorFileOperations (asciidoctor-gradle-base 4.0.4 API)

org.asciidoctor.gradle.base.internal.DefaultAsciidoctorFileOperations

All Implemented Interfaces and Traits:

AsciidoctorTaskFileOperations, AsciidoctorTaskTreeOperations
```
@groovy.transform.CompileStatic
@SuppressWarnings(value: MethodCount)
class DefaultAsciidoctorFileOperations
extends Object
implements AsciidoctorTaskFileOperations, AsciidoctorTaskTreeOperations
```
Implements Asciidoctor conversion task file operations. Instances of this is meant to be used via delegation.
Since:
4.0
Authors:
Schalk W. Cronjé
Lari Hotari
Gary Hale

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`DefaultAsciidoctorFileOperations.1`

Properties Summary

Properties
Type	Name and description
`String`	`engineName`
`List<String>`	`languages`
`boolean`	`logDocuments` Logs documents as they are converted
`File`	`outputDir`

Constructor Summary

Constructors
Constructor and description
`DefaultAsciidoctorFileOperations (Task task, String engineName)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`checkForIncompatiblePathRoots(BaseDirStrategy baseDir)` Validates that the path roots are sane.
	`void`	`checkForInvalidSourceDocuments()` Validates the source tree
	`void`	`clearSecondarySources()` Clears any of the existing secondary soruces patterns.
	`void`	`clearSources()` Clears existing sources patterns.
	`Set<File>`	`getBackendOutputDirectories()` Returns a list of all output directories by backend
	`CopySpec`	`getDefaultResourceCopySpec(Optional<String> lang)` The default CopySpec that will be used if `resources` was never called
	`PatternSet`	`getDefaultSecondarySourceDocumentPattern()` The default pattern set for secondary sources.
	`PatternSet`	`getDefaultSourceDocumentPattern()` The default PatternSet that will be used if `sources` was never called
	`Provider<PatternSet>`	`getIntermediateArtifactPatternProvider()` A provider of patterns identifying intermediate artifacts.
	`Provider<File>`	`getIntermediateWorkDirProvider()` The directory that will be the intermediate directory should one be required.
	`CopySpec`	`getLanguageResourceCopySpec(String lang)` Returns the copy specification for the resources of a specific language.
	`FileTree`	`getLanguageSecondarySourceFileTree(String lang)` Gets the language-specific secondary source tree.
	`FileTree`	`getLanguageSourceFileTree(String lang)` Gets the language-specific source tree
	`List<String>`	`getLanguages()` Obtain List of languages the sources documents are written in.
	`File`	`getOutputDir()` Returns the current toplevel output directory
	`File`	`getOutputDirFor(String backendName)` Get the output directory for a specific backend.
	`DirectoryProperty`	`getOutputDirProperty()` Returns the current toplevel output directory as a property object.
	`CopySpec`	`getResourceCopySpec(Optional<String> lang)` Gets the CopySpec for additional resources.
	`FileTree`	`getSecondarySourceFileTree()` Returns a FileTree containing all of the secondary source documents.
	`FileTree`	`getSecondarySourceFileTreeFrom(File dir)` Obtains a secondary source tree based on patterns.
	`DirectoryProperty`	`getSourceDirProperty()` Returns the parent directory for Asciidoctor source as a property object.
	`FileTree`	`getSourceFileTree()` Returns a FileTree containing all of the source documents
	`FileTree`	`getSourceFileTreeFrom(File dir)` Obtains a source tree based on patterns.
	`Map<String, ?>`	`getTaskSpecificDefaultAttributes(File workingSourceDir)` A task may add some default attributes.
	`boolean`	`hasIntermediateWorkDir()` Checks whether an intermediate workdir is required.
	`void`	`languages(Iterable<String> langs)` Add to list of languages to process.
	`void`	`languages(String[] langs)` Add to list of languages to process.
	`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.
	`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 Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - final String engineName
  - List<String> languages
  - boolean logDocuments
    
    Logs documents as they are converted
  - File outputDir
- Constructor Detail
  - DefaultAsciidoctorFileOperations(Task task, String engineName)
- Method Detail
  - @Override void checkForIncompatiblePathRoots(@Nullable BaseDirStrategy baseDir)
    
    Validates that the path roots are sane.
    Parameters:
    baseDir - Base directory strategy. Can be null
  - @Override void checkForInvalidSourceDocuments()
    
    Validates the source tree
  - @Override void clearSecondarySources()
    
    Clears any of the existing secondary soruces patterns. This should be used if none of the default patterns should be monitored.
  - @Override void clearSources()
    
    Clears existing sources patterns.
  - @Override Set<File> getBackendOutputDirectories()
    
    Returns a list of all output directories by backend
    Since:
    1.5.1
  - @Override 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 PatternSet getDefaultSecondarySourceDocumentPattern()
    
    The default pattern set for secondary sources.
    Returns:
    By default all *.adoc,*.ad,*.asc,*.asciidoc is included.
  - @Override PatternSet getDefaultSourceDocumentPattern()
    
    The default PatternSet that will be used if sources was never called
    Returns:
    By default all *.adoc,*.ad,*.asc,*.asciidoc is included. Files beginning with underscore are excluded
  - @Override Provider<PatternSet> getIntermediateArtifactPatternProvider()
    
    A provider of patterns identifying intermediate artifacts.
    Returns:
    Provider to a PatternSet. Can be empty.
  - @Override Provider<File> getIntermediateWorkDirProvider()
    
    The directory that will be the intermediate directory should one be required.
    Returns:
    Intermediate working directory
  - @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.
  - @Override FileTree getLanguageSecondarySourceFileTree(String lang)
    
    Gets the language-specific secondary source tree.
    Parameters:
    lang - Language
    Returns:
    Language-specific source tree.
  - @Override FileTree getLanguageSourceFileTree(String lang)
    
    Gets the language-specific source tree
    Parameters:
    lang - Language
    Returns:
    Language-specific source tree.
  - @Override 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
  - @Override File getOutputDir()
    
    Returns the current toplevel output directory
  - File getOutputDirFor(String backendName)
    
    Get the output directory for a specific backend.
    Parameters:
    backendName - Name of backend
    Returns:
    Output directory.
  - @Override DirectoryProperty getOutputDirProperty()
    
    Returns the current toplevel output directory as a property object.
  - @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.
  - @Override 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
  - @Override FileTree getSecondarySourceFileTreeFrom(File dir)
    
    Obtains a secondary source tree based on patterns.
    Parameters:
    dir - Toplevel source directory.
    Returns:
    Source tree based upon configured pattern.
  - @Override DirectoryProperty getSourceDirProperty()
    
    Returns the parent directory for Asciidoctor source as a property object.
  - @Override 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
  - @Override FileTree getSourceFileTreeFrom(File dir)
    
    Obtains a source tree based on patterns.
    Parameters:
    dir - Toplevel source directory.
    Returns:
    Source tree based upon configured pattern.
  - @Override Map<String, ?> 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.
  - @Override void languages(Iterable<String> langs)
    
    Add to list of languages to process.
    Parameters:
    langs - List of additional languages
    Since:
    3.0.0
  - @Override void languages(String[] langs)
    
    Add to list of languages to process.
    Parameters:
    langs - List of additional languages
    Since:
    3.0.0
  - @Override 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
  - @Override 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
  - @Override 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
  - @Override 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
  - @Override void secondarySources(groovy.lang.Closure cfg)
    
    Configures secondary sources.
    Parameters:
    cfg - Configuration closure. Is passed a PatternSet.
  - @Override void secondarySources(Action<? super PatternSet> cfg)
    
    Configures sources.
    Parameters:
    cfg - Configuration Action. Is passed a PatternSet.
  - @Override 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
  - @Override void setOutputDir(Object f)
    
    Sets the new Asciidoctor parent output directory.
    Parameters:
    f - An object convertible via project.file
  - @Override void setSourceDir(Object f)
    
    Sets the new Asciidoctor parent source directory.
    Parameters:
    f - Any object convertible with project.file.
  - @Override 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
  - @Override void sources(groovy.lang.Closure cfg)
    
    Configures sources.
    Parameters:
    cfg - Configuration closure. Is passed a PatternSet.
  - @Override void sources(Action<? super PatternSet> cfg)
    
    Configures sources.
    Parameters:
    cfg - Configuration Action. Is passed a PatternSet.
  - @Override void sources(String[] includePatterns)
    
    Include source patterns.
    Parameters:
    includePatterns - ANT-style patterns for sources to include
  - @Override 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
  - @Override 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.
    Parameters:
    cfg - Configures a PatternSet with a base directory of the intermediate working directory.
  - @Override 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
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class DefaultAsciidoctorFileOperations

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final String engineName

List<String> languages

boolean logDocuments

File outputDir

Constructor Detail

DefaultAsciidoctorFileOperations(Task task, String engineName)

Method Detail

@Override void checkForIncompatiblePathRoots(@Nullable BaseDirStrategy baseDir)

@Override void checkForInvalidSourceDocuments()

@Override void clearSecondarySources()

@Override void clearSources()

@Override Set<File> getBackendOutputDirectories()

@Override CopySpec getDefaultResourceCopySpec(Optional<String> lang)

@Override PatternSet getDefaultSecondarySourceDocumentPattern()

@Override PatternSet getDefaultSourceDocumentPattern()

@Override Provider<PatternSet> getIntermediateArtifactPatternProvider()

@Override Provider<File> getIntermediateWorkDirProvider()

@Override CopySpec getLanguageResourceCopySpec(String lang)

@Override FileTree getLanguageSecondarySourceFileTree(String lang)

@Override FileTree getLanguageSourceFileTree(String lang)

@Override List<String> getLanguages()

@Override File getOutputDir()

File getOutputDirFor(String backendName)

@Override DirectoryProperty getOutputDirProperty()

@Override CopySpec getResourceCopySpec(Optional<String> lang)

@Override FileTree getSecondarySourceFileTree()

@Override FileTree getSecondarySourceFileTreeFrom(File dir)

@Override DirectoryProperty getSourceDirProperty()

@Override FileTree getSourceFileTree()

@Override FileTree getSourceFileTreeFrom(File dir)

@Override Map<String, ?> getTaskSpecificDefaultAttributes(File workingSourceDir)

@Override boolean hasIntermediateWorkDir()

@Override void languages(Iterable<String> langs)

@Override void languages(String[] langs)

@Override void resources(groovy.lang.Closure cfg)

@Override void resources(Action<? super CopySpec> cfg)

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

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

@Override void secondarySources(groovy.lang.Closure cfg)

@Override void secondarySources(Action<? super PatternSet> cfg)

@Override void setLanguages(Iterable<String> langs)

@Override void setOutputDir(Object f)

@Override void setSourceDir(Object f)

@Override void sourceDir(Object f)

@Override void sources(groovy.lang.Closure cfg)

@Override void sources(Action<? super PatternSet> cfg)

@Override void sources(String[] includePatterns)

@Override void useIntermediateWorkDir()

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

@Override void withIntermediateArtifacts(Action<PatternSet> cfg)