DefaultAsciidoctorOutputOptions (asciidoctor-gradle-base 4.0.4 API)

org.asciidoctor.gradle.base.internal.DefaultAsciidoctorOutputOptions

All Implemented Interfaces and Traits:: AsciidoctorTaskOutputOptions

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class DefaultAsciidoctorOutputOptions
extends Object
implements AsciidoctorTaskOutputOptions

Implementation of output options for Asciidoctor tasks

Authors:: Schalk W. Cronjé

Since:: 4.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`DefaultAsciidoctorOutputOptions.1`

Constructor Summary

Constructors
Constructor and description
`DefaultAsciidoctorOutputOptions (org.ysb33r.grolifant.api.core.ProjectOperations po, String taskName, AsciidoctorTaskFileOperations atfo)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Set<String>`	`backends()` The current set of configured Asciidoctor backends.
	`void`	`configureOutputOptions(groovy.lang.Closure cfg)` Configures output options for this task.
	`void`	`configureOutputOptions(Action<OutputOptions> cfg)` Configures output options for this task.
	`void`	`copyAllResources()` Copies all resources to the output directory.
	`void`	`copyNoResources()` Do not copy any resources to the output directory.
	`void`	`copyResourcesByBackend(String backendName, File sourceDir, File outputDir, Optional<String> includeLang)` Copy resources for a backend.
	`void`	`copyResourcesOnlyIf(String[] backendNames)` Copy resources to the output directory only if the backend names matches any of the specified names.
	`Set<File>`	`getBackendOutputDirectories()` Returns a list of all output directories by backend
	`Optional<List<String>>`	`getCopyResourcesForBackends()` List of backends for which to copy resources.
	`File`	`getOutputDirForBackend(String backendName)` Get the output directory for a specific backend.
	`File`	`getOutputDirForBackend(String backendName, String language)` Get the output directory for a specific backend.
	`OutputOptions`	`getOutputOptions()` Access to the underlying OutputOptions.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - DefaultAsciidoctorOutputOptions(org.ysb33r.grolifant.api.core.ProjectOperations po, String taskName, AsciidoctorTaskFileOperations atfo)
- Method Detail
  - @Override Set<String> backends()
    
    The current set of configured Asciidoctor backends.
    Returns:
    Backends. Can be empty. Never null.
  - void configureOutputOptions(@groovy.lang.DelegatesTo(value: OutputOptions) groovy.lang.Closure cfg)
    
    Configures output options for this task.
    Parameters:
    cfg - Closure which will delegate to a OutputOptions instance.
  - void configureOutputOptions(Action<OutputOptions> cfg)
    
    Configures output options for this task.
    Parameters:
    cfg - Action which will be passed an instances of OutputOptions to configure.
  - @Override 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.
  - @Override void copyNoResources()
    
    Do not copy any resources to the output directory. Some backends (such as pdf) process all resources in place.
  - @Override void copyResourcesByBackend(String backendName, File sourceDir, File outputDir, Optional<String> includeLang)
    
    Copy resources for a backend.
    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
  - @Override void copyResourcesOnlyIf(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.
  - @Override Set<File> getBackendOutputDirectories()
    
    Returns a list of all output directories by backend
    Returns:
    Output directories
  - @Override Optional<List<String>> getCopyResourcesForBackends()
    
    List of backends for which to copy resources.
    Returns:
    List of backends. Can be null.
  - @Override File getOutputDirForBackend(String backendName)
    
    Get the output directory for a specific backend.
    Parameters:
    backendName - Name of backend
    Returns:
    Output directory.
  - @Override File getOutputDirForBackend(String backendName, 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.
  - @Override OutputOptions getOutputOptions()
    
    Access to the underlying OutputOptions.
    Returns:
    OutputOptions instance.

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class DefaultAsciidoctorOutputOptions

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

DefaultAsciidoctorOutputOptions(org.ysb33r.grolifant.api.core.ProjectOperations po, String taskName, AsciidoctorTaskFileOperations atfo)

Method Detail

@Override Set<String> backends()

void configureOutputOptions(@groovy.lang.DelegatesTo(value: OutputOptions) groovy.lang.Closure cfg)

void configureOutputOptions(Action<OutputOptions> cfg)

@Override void copyAllResources()

@Override void copyNoResources()

@Override void copyResourcesByBackend(String backendName, File sourceDir, File outputDir, Optional<String> includeLang)

@Override void copyResourcesOnlyIf(String[] backendNames)

@Override Set<File> getBackendOutputDirectories()

@Override Optional<List<String>> getCopyResourcesForBackends()

@Override File getOutputDirForBackend(String backendName)

@Override File getOutputDirForBackend(String backendName, String language)

@Override OutputOptions getOutputOptions()