org.asciidoctor.gradle.model5.core

Interface AsciidoctorConversionSettings

public interface AsciidoctorConversionSettings

Describes the source documents, attributes etc. required for a conversion.

This is a focus on the conversions themselves, and not the engine for running the conversion.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
org.gradle.api.provider.Provider<java.lang.Boolean>	getAdjustBaseDirPerFile() Whether the engine should change the base directory prior to converting a file.
org.gradle.api.provider.Provider<java.util.Map<java.lang.String,java.lang.String>>	getAttributes() Document attributes.
org.gradle.api.provider.Provider<AsciidoctorNamedBackend>	getBackend() Backend to use.
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getBaseDir() Base directory.
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getDestinationDir() Destination directory.
org.gradle.api.provider.Provider<org.asciidoctor.gradle.model5.core.DocType>	getDocType() Document type.
org.gradle.api.provider.Provider<java.lang.Boolean>	getEmbedded() Whether embedded processing should be performed.
org.gradle.api.provider.Provider<java.util.Set<java.util.regex.Pattern>>	getFatalWarnings() Patterns of warnings which must be treated as errors.
org.gradle.api.provider.Provider<java.util.Map<java.lang.String,ScriptCollection>>	getScriptCollections() A collection of scripts, grouped by implementation language.
org.gradle.api.provider.Provider<java.util.Set<java.io.File>>	getSourceFiles() Source files.
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getSourceRootDir() The root directory where source files are located.
org.gradle.api.provider.Provider<ConversionTemplate>	getTemplates() When an output formatter supports templates, this may be populated.

Method Detail

getSourceFiles

org.gradle.api.provider.Provider<java.util.Set<java.io.File>> getSourceFiles()

Source files.

Returns:

Set of files. Must be present and contain at least one document.

getBackend

org.gradle.api.provider.Provider<AsciidoctorNamedBackend> getBackend()

Backend to use.

Returns:

Backend. Must be present.

getSourceRootDir

org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getSourceRootDir()

The root directory where source files are located.

Returns:

Base directory for all source files. Must be present.

getBaseDir

org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getBaseDir()

Base directory.

Returns:

Base directory as presented to Asciidoctor. Must be present.

getAdjustBaseDirPerFile

org.gradle.api.provider.Provider<java.lang.Boolean> getAdjustBaseDirPerFile()

Whether the engine should change the base directory prior to converting a file. There is performance penalty if this is set to true

Returns:

Provider to whether the base directory should be adjusted.

getDestinationDir

org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getDestinationDir()

Destination directory.

Returns:

Directory for output. Must be present.

getAttributes

org.gradle.api.provider.Provider<java.util.Map<java.lang.String,java.lang.String>> getAttributes()

Document attributes.

Returns:

All attributes. Must be present, but can be an empty map.

getDocType

org.gradle.api.provider.Provider<org.asciidoctor.gradle.model5.core.DocType> getDocType()

Document type.

Returns:

Optional document type. Provider does not need to be present.

getFatalWarnings

org.gradle.api.provider.Provider<java.util.Set<java.util.regex.Pattern>> getFatalWarnings()

Patterns of warnings which must be treated as errors.

Returns:

List of patterns. Must be present, but list can be empty.

getEmbedded

org.gradle.api.provider.Provider<java.lang.Boolean> getEmbedded()

Whether embedded processing should be performed.

This is an option that only makes sense for certain backends.

Returns:

Provider that will return true if embedded processing should be performed

getTemplates

org.gradle.api.provider.Provider<ConversionTemplate> getTemplates()

When an output formatter supports templates, this may be populated. For other cases this will always be empty.

Returns:

Provider to templates.

getScriptCollections

org.gradle.api.provider.Provider<java.util.Map<java.lang.String,ScriptCollection>> getScriptCollections()

A collection of scripts, grouped by implementation language.

Returns:

Provider to the collection. Can be empty.