AntoraBuildSiteTask (ysf-documentation-antora-plugin 1.0.0 API)

org.ysb33r.ysf.projects.antora.AntoraBuildSiteTask

@groovy.transform.CompileStatic
class AntoraBuildSiteTask
extends org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask

Builds an Antora site.

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	`__$stMC, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`Boolean`	`failOnWarnings`
`Boolean`	`fetchContent`
`Provider<File>`	`outputDir`

Constructor Summary

Constructors
Constructor and description
`AntoraBuildSiteTask ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exec()`
	`Provider<File>`	`getOutputDir()` Where to generate content into.
	`void`	`setAntoraWorkingDir(Provider<File> wd)` Sets the Antora working directory.
	`void`	`setEnvironmentProvider(Provider<java.util.Map<String, String>> map)` Provides additional environment variables.
	`void`	`setIgnoreWarnings(Provider<java.util.List<java.util.regex.Pattern>> patterns)` Sets a list of warnings to be ignored when failOnWarnings is `true`.
	`void`	`setLogFile(Object file)` Sets a log file.
	`void`	`setOutputDir(Object file)` Sets the destination directory

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#projectTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#providerTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#fsOperations(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#stringTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#execTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#jvmTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#problemReporter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMetaClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getName(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(org.gradle.api.Task), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogger(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#property(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getExtensions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDescription(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAnt(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogging(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDir(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#mustRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMustRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMustRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#finalizedBy([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setFinalizedBy(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getFinalizedBy(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#shouldRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setShouldRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getShouldRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#usesService(org.gradle.api.provider.Provider), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getGroup(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setGroup(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDependsOn(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDependsOn(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDidWork(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setActions(java.util.List), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#dependsOn([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDidWork(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDestroyables(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLocalState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTimeout(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDescription(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setEnabled(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAsDynamicObject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getConvention(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notCompatibleWithConfigurationCache(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doNotTrackState(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getIdentityPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getSharedResources(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getStandardOutputCapture(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#acceptServiceReferences(java.util.Set), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskIdentity(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOnlyIf(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonNotToTrackState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isCompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonTaskIsIncompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getImpliesSubProjects(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setImpliesSubProjects(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDirFactory(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isHasCustomActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getRequiredServices(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#equals(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#toString(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hashCode(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notify(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notifyAll(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long, int), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#invokeMethod(java.lang.String, java.lang.Object)

- Property Detail
  - @Internal Boolean failOnWarnings
  - @Internal Boolean fetchContent
  - Provider<File> outputDir
- Constructor Detail
  - @SuppressWarnings(value: ThisReferenceEscapesConstructor) AntoraBuildSiteTask()
- Method Detail
  - @TaskAction @SuppressWarnings(value: UnnecessarySetter) void exec()
  - @OutputDirectory Provider<File> getOutputDir()
    
    Where to generate content into.
    Returns:
    Provider to destination directory
  - void setAntoraWorkingDir(Provider<File> wd)
    
    Sets the Antora working directory.
    Parameters:
    wd - Provider to the working dir.
    Since:
    1.0
  - void setEnvironmentProvider(Provider<java.util.Map<String, String>> map)
    
    Provides additional environment variables.
    Parameters:
    map - Provider to the map of environment variables.
  - void setIgnoreWarnings(Provider<java.util.List<java.util.regex.Pattern>> patterns)
    
    Sets a list of warnings to be ignored when failOnWarnings is true.
    Parameters:
    patterns - Provider to a list of message patterns.
  - void setLogFile(Object file)
    
    Sets a log file. This is optional. If no logfile is provided, log output will be sent to the console.
    Parameters:
    file - Location of log file.
  - void setOutputDir(Object file)
    
    Sets the destination directory
    Parameters:
    file - Something convertible to a file.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AntoraBuildSiteTask

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@Internal Boolean failOnWarnings

@Internal Boolean fetchContent

Provider<File> outputDir

Constructor Detail

@SuppressWarnings(value: ThisReferenceEscapesConstructor) AntoraBuildSiteTask()

Method Detail

@TaskAction @SuppressWarnings(value: UnnecessarySetter) void exec()

@OutputDirectory Provider<File> getOutputDir()

void setAntoraWorkingDir(Provider<File> wd)

void setEnvironmentProvider(Provider<java.util.Map<String, String>> map)

void setIgnoreWarnings(Provider<java.util.List<java.util.regex.Pattern>> patterns)

void setLogFile(Object file)

void setOutputDir(Object file)