Package io.github.jcohy.gradle.antora

Class GenerateAntoraYmlTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.jcohy.gradle.antora.GenerateAntoraYmlTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class GenerateAntoraYmlTask extends org.gradle.api.DefaultTask
Copyright: Copyright (c) 2023 jcohy.com

Description:

Since:
2024.0.1

  • Nested Class Summary

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

    org.gradle.api.Task.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    GenerateAntoraYmlTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.MapProperty<String,Object>
    getAsciidoc()
     
    abstract org.gradle.api.provider.MapProperty<String,Object>
    getAsciidocAttributes()
     
    abstract org.gradle.api.provider.Property<String>
    getVersion()
    The version of the documentation used to determine Antora's version and prerelease attributes.
    void
    writeAntoraYml()
     

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • GenerateAntoraYmlTask

      public GenerateAntoraYmlTask()

  • Method Details

    • getVersion

      @Internal public abstract org.gradle.api.provider.Property<String> getVersion()
      The version of the documentation used to determine Antora's version and prerelease attributes. Defaults to the project version.
      Returns:

    • getAsciidocAttributes

      @Internal public abstract org.gradle.api.provider.MapProperty<String,Object> getAsciidocAttributes()

    • getAsciidoc

      @Internal public abstract org.gradle.api.provider.MapProperty<String,Object> getAsciidoc()

    • writeAntoraYml

      public void writeAntoraYml() throws IOException
      Throws:
      IOException