org.asciidoctor.gradle.base

Interface AsciidoctorTaskTreeOperations

public interface AsciidoctorTaskTreeOperations

Additional operations on the source and destinations trees for Asciidoctor conversions.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	checkForIncompatiblePathRoots(org.asciidoctor.gradle.base.BaseDirStrategy baseDir) Validates that the path roots are sane.
void	checkForInvalidSourceDocuments() Validates the source tree
org.gradle.api.tasks.util.PatternSet	getDefaultSecondarySourceDocumentPattern() The default pattern set for secondary sources.
org.gradle.api.tasks.util.PatternSet	getDefaultSourceDocumentPattern() The default PatternSet that will be used if sources was never called
org.gradle.api.file.FileTree	getLanguageSecondarySourceFileTree(java.lang.String lang) Gets the language-specific secondary source tree.
org.gradle.api.file.FileTree	getLanguageSourceFileTree(java.lang.String lang) Gets the language-specific source tree
org.gradle.api.file.FileTree	getSecondarySourceFileTreeFrom(java.io.File dir) Obtains a secondary source tree based on patterns.
org.gradle.api.file.FileTree	getSourceFileTreeFrom(java.io.File dir) Obtains a source tree based on patterns.

Method Detail

checkForIncompatiblePathRoots

void checkForIncompatiblePathRoots(@Nullable
                                   org.asciidoctor.gradle.base.BaseDirStrategy baseDir)

Validates that the path roots are sane.

Parameters:

baseDir - Base directory strategy. Can be null

checkForInvalidSourceDocuments

void checkForInvalidSourceDocuments()
                             throws org.gradle.api.InvalidUserDataException

Validates the source tree

Throws:

org.gradle.api.InvalidUserDataException

getDefaultSecondarySourceDocumentPattern

@Internal
org.gradle.api.tasks.util.PatternSet getDefaultSecondarySourceDocumentPattern()
                                                                                 throws org.gradle.api.InvalidUserDataException

The default pattern set for secondary sources.

Returns:

By default all *.adoc,*.ad,*.asc,*.asciidoc is included.

Throws:

org.gradle.api.InvalidUserDataException

getDefaultSourceDocumentPattern

@Internal
org.gradle.api.tasks.util.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

getLanguageSecondarySourceFileTree

@Internal
org.gradle.api.file.FileTree getLanguageSecondarySourceFileTree(java.lang.String lang)

Gets the language-specific secondary source tree.

Parameters:

lang - Language

Returns:

Language-specific source tree.

getLanguageSourceFileTree

@Internal
org.gradle.api.file.FileTree getLanguageSourceFileTree(java.lang.String lang)

Gets the language-specific source tree

Parameters:

lang - Language

Returns:

Language-specific source tree.

getSecondarySourceFileTreeFrom

@Internal
org.gradle.api.file.FileTree getSecondarySourceFileTreeFrom(java.io.File dir)

Obtains a secondary source tree based on patterns.

Parameters:

dir - Toplevel source directory.

Returns:

Source tree based upon configured pattern.

getSourceFileTreeFrom

@Internal
org.gradle.api.file.FileTree getSourceFileTreeFrom(java.io.File dir)

Obtains a source tree based on patterns.

Parameters:

dir - Toplevel source directory.

Returns:

Source tree based upon configured pattern.