org.asciidoctor.gradle.model5.core.publications

Interface AsciidoctorOutputData

All Superinterfaces:

org.gradle.api.Named

public interface AsciidoctorOutputData
extends org.gradle.api.Named

Holds data regarding a publication output.

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

org.gradle.api.Named.Namer

Method Summary

Modifier and Type	Method and Description
org.gradle.api.file.FileCollection	getAdditionalClasspath() Additional classpath to add for execution.
org.gradle.api.provider.Provider<AsciidoctorNamedBackend>	getBackend() The named backend for this formatter.
org.gradle.api.provider.Provider<ConversionTemplate>	getConversionTemplate() If the formatter has configured templates, it can be set here.
org.gradle.api.provider.Provider<org.gradle.api.tasks.util.PatternFilterable>	getCopyResources() Whether resources should be copied.
org.gradle.api.provider.Provider<org.asciidoctor.gradle.model5.core.DocType>	getDocType() Get the documentation type that needs to be based to the engine at run time.
org.gradle.api.provider.Provider<java.lang.Boolean>	getEmbedded() Whether embedded processing should be performed.
org.gradle.api.provider.Provider<java.lang.String>	getFormatterName() The actual name of the formatter, but not the alias name.
org.gradle.api.provider.Provider<java.util.Set<java.lang.String>>	getModuleRequires() List modules which need to be explicitly called out as being required.
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getOutputDir() Directory where output will be written to.
org.gradle.api.provider.Provider<java.lang.String>	getToolchainName() The name of the toolchain.

Methods inherited from interface org.gradle.api.Named

getName

Method Detail

getOutputDir

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

Directory where output will be written to.

Returns:

Provider to directory.

getBackend

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

The named backend for this formatter.

Returns:

Provider to the named backend.

getCopyResources

org.gradle.api.provider.Provider<org.gradle.api.tasks.util.PatternFilterable> getCopyResources()

Whether resources should be copied.

Returns:

A provider to a copy spec. Can be empty if resources should not be copied to the output directory.

getDocType

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

Get the documentation type that needs to be based to the engine at run time.

Returns:

Documentation type. Can be empty.

getModuleRequires

org.gradle.api.provider.Provider<java.util.Set<java.lang.String>> getModuleRequires()

List modules which need to be explicitly called out as being required.

Returns:

Provider to a list. Can be empty, but never null.

getFormatterName

org.gradle.api.provider.Provider<java.lang.String> getFormatterName()

The actual name of the formatter, but not the alias name.

Returns:

Provider to the name.

getToolchainName

org.gradle.api.provider.Provider<java.lang.String> getToolchainName()

The name of the toolchain.

Returns:

Provider to the name.

getAdditionalClasspath

org.gradle.api.file.FileCollection getAdditionalClasspath()

Additional classpath to add for execution.

Returns:

Classpath

getEmbedded

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

Whether embedded processing should be performed.

Returns:

Embedded provider

getConversionTemplate

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

If the formatter has configured templates, it can be set here.

Returns:

Template information when available, mostly empty.