org.asciidoctor.gradle.model5.core.formatters

Interface AsciidoctorOutputFormatter

All Superinterfaces:

AsciidoctorRequires, CanConfigureTaskInputs, HasAttributeProvider, HasDisplayType, org.gradle.api.Named

All Known Subinterfaces:

AsciidoctorGenericOutputFormatter

public interface AsciidoctorOutputFormatter
extends org.gradle.api.Named, AsciidoctorRequires, HasAttributeProvider, HasDisplayType, CanConfigureTaskInputs

Defines an output formatter.

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.provider.Provider<AsciidoctorNamedBackend>	getBackend() What this is known to Asciidoctor as the backend.
org.gradle.api.file.FileCollection	getClasspath() Additional items to add to the classpath when a conversion involving the output formatter is executed.
boolean	getCopyResources() Whether resource files should be copied to the output directory.
default java.util.Optional<org.asciidoctor.gradle.model5.core.DocType>	getEnforcedDocType() Indicates that this backend always requires a specific document type and will try to enforce it.

Methods inherited from interface org.gradle.api.Named

getName

Methods inherited from interface org.asciidoctor.gradle.model5.core.AsciidoctorRequires

getRequires

Methods inherited from interface org.asciidoctor.gradle.model5.core.attributes.HasAttributeProvider

getAttributeProvider

Methods inherited from interface org.asciidoctor.gradle.model5.core.HasDisplayType

getDisplayType

Methods inherited from interface org.asciidoctor.gradle.model5.core.CanConfigureTaskInputs

configureTaskInputs

Method Detail

getBackend

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

What this is known to Asciidoctor as the backend.

It is possible to register more than one output formatter of the same type, but with different settings. The backend name will always be the same in this case.

Returns:

Backend name.

getCopyResources

boolean getCopyResources()

Whether resource files should be copied to the output directory.

Returns:

true if resources should be copied.

getEnforcedDocType

default java.util.Optional<org.asciidoctor.gradle.model5.core.DocType> getEnforcedDocType()

Indicates that this backend always requires a specific document type and will try to enforce it.

The default is not to enforce a document type.

Returns:

Enforced document type. Can be empty indicating that nothing is enforced.

getClasspath

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

Additional items to add to the classpath when a conversion involving the output formatter is executed.

The classpath is empty by default.

Returns:

Classpath. Can be null to indicate that the formatter does not support additional classpath.