Package net.kyori.indra.crossdoc

Class GenerateOfflineLinks

  • All Implemented Interfaces:
    java.lang.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 GenerateOfflineLinks
extends org.gradle.api.DefaultTask
    Generate an options file containing -linkoffline info for passing into Javadoc tasks.
    Since:
    2.1.0

    • 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void generateArgumentFile()  
      protected abstract org.gradle.api.file.ConfigurableFileCollection getLinkableArtifactFiles()  
      abstract org.gradle.api.provider.SetProperty<org.gradle.api.artifacts.result.ResolvedArtifactResult> getLinkableArtifacts()
      A collection of artifacts on the compile classpath, to generate links to.
      abstract org.gradle.api.provider.Property<java.lang.String> getLinkBaseUrl()
      The base URL for submodule links.
      abstract org.gradle.api.file.RegularFileProperty getOutputFile()
      The output file that the generated arguments for the javadoc tool will be written to.
      abstract org.gradle.api.provider.Property<ProjectDocumentationUrlProvider> getUrlProvider()
      A provider that computes project URLs, relative to the link base URL.

      • 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

        acceptServiceReferences, 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 Detail

      • GenerateOfflineLinks

        public GenerateOfflineLinks()

    • Method Detail

      • getLinkBaseUrl

        @Input
public abstract org.gradle.api.provider.Property<java.lang.String> getLinkBaseUrl()
        The base URL for submodule links.
        Returns:
        the link root
        Since:
        2.1.0

      • getUrlProvider

        public abstract org.gradle.api.provider.Property<ProjectDocumentationUrlProvider> getUrlProvider()
        A provider that computes project URLs, relative to the link base URL.
        Returns:
        a provider for the relative project URL
        Since:
        2.1.0

      • getLinkableArtifactFiles

        @InputFiles
protected abstract org.gradle.api.file.ConfigurableFileCollection getLinkableArtifactFiles()

      • getLinkableArtifacts

        @Internal
public abstract org.gradle.api.provider.SetProperty<org.gradle.api.artifacts.result.ResolvedArtifactResult> getLinkableArtifacts()
        A collection of artifacts on the compile classpath, to generate links to.
        Returns:
        a property including linkable artifacts.
        Since:
        3.0.0

      • getOutputFile

        @OutputFile
public abstract org.gradle.api.file.RegularFileProperty getOutputFile()
        The output file that the generated arguments for the javadoc tool will be written to.
        Returns:
        the output file
        Since:
        2.1.0

      • generateArgumentFile

        public void generateArgumentFile()
                          throws java.io.IOException
        Throws:
        java.io.IOException