org.asciidoctor.gradle.base

Interface AsciidoctorTaskOutputOptions

public interface AsciidoctorTaskOutputOptions

Asciidoctor conversion output options.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	backends() The current set of configured Asciidoctor backends.
void	copyAllResources() Copies all resources to the output directory.
void	copyNoResources() Do not copy any resources to the output directory.
void	copyResourcesByBackend(java.lang.String backendName, java.io.File sourceDir, java.io.File outputDir, java.util.Optional<java.lang.String> includeLang) Copy resources for a backend name.
void	copyResourcesOnlyIf(java.lang.String... backendNames) Copy resources to the output directory only if the backend names matches any of the specified names.
java.util.Set<java.io.File>	getBackendOutputDirectories() Returns a list of all output directories by backend
java.util.Optional<java.util.List<java.lang.String>>	getCopyResourcesForBackends() List of backends for which to copy resources.
java.io.File	getOutputDirForBackend(java.lang.String backendName) Get the output directory for a specific backend.
java.io.File	getOutputDirForBackend(java.lang.String backendName, java.lang.String language) Get the output directory for a specific backend.
org.asciidoctor.gradle.base.OutputOptions	getOutputOptions() Access to the underlying OutputOptions.

Method Detail

backends

java.util.Set<java.lang.String> backends()

The current set of configured Asciidoctor backends.

Returns:

Backends. Can be empty. Never null.

copyAllResources

void copyAllResources()

Copies all resources to the output directory. Some backends (such as html5) require all resources to be copied to the output directory. This is the default behaviour for this task.

copyNoResources

void copyNoResources()

Do not copy any resources to the output directory. Some backends (such as pdf) process all resources in place.

copyResourcesByBackend

void copyResourcesByBackend(java.lang.String backendName,
                            java.io.File sourceDir,
                            java.io.File outputDir,
                            java.util.Optional<java.lang.String> includeLang)

Copy resources for a backend name.

Parameters:

backendName - Name of backend for which resources are copied

sourceDir - Source directory of resources

outputDir - Final output directory.

includeLang - If set also copy resources for this specified language

copyResourcesOnlyIf

void copyResourcesOnlyIf(java.lang.String... backendNames)

Copy resources to the output directory only if the backend names matches any of the specified names.

Parameters:

backendNames - List of names for which resources should be copied.

getBackendOutputDirectories

@OutputDirectories
java.util.Set<java.io.File> getBackendOutputDirectories()

Returns a list of all output directories by backend

Returns:

Output directories

getCopyResourcesForBackends

@Internal
java.util.Optional<java.util.List<java.lang.String>> getCopyResourcesForBackends()

List of backends for which to copy resources.

Returns:

List of backends. Can be null.

getOutputDirForBackend

java.io.File getOutputDirForBackend(java.lang.String backendName)

Get the output directory for a specific backend.

Parameters:

backendName - Name of backend

Returns:

Output directory.

getOutputDirForBackend

java.io.File getOutputDirForBackend(java.lang.String backendName,
                                    java.lang.String language)

Get the output directory for a specific backend.

Parameters:

backendName - Name of backend

language - Language for which sources are being generated.

Returns:

Output directory.

getOutputOptions

org.asciidoctor.gradle.base.OutputOptions getOutputOptions()

Access to the underlying OutputOptions.

Returns:

OutputOptions instance.