Package io.github.jwharm.flatpakgradlegenerator

Class FlatpakGradleGeneratorTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.jwharm.flatpakgradlegenerator.FlatpakGradleGeneratorTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Task resolves project dependencies") public abstract class FlatpakGradleGeneratorTask extends org.gradle.api.DefaultTask
A task that creates a sources list file with all Gradle dependencies, so they can be downloaded for an offline build.

  • Nested Class Summary

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

    org.gradle.api.Named.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
    FlatpakGradleGeneratorTask()
    Create a new instance of the task.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    apply()
    Run the flatpakGradleGenerator task.
    abstract org.gradle.api.provider.Property<String>
    getDownloadDirectory()
    Specifies the value for the "dest" attribute in the json file.
    abstract org.gradle.api.provider.SetProperty<String>
    getExcludeConfigurations()
    The names of Gradle's Configuration to exclude from dependency collection.
    abstract org.gradle.api.provider.SetProperty<String>
    getIncludeConfigurations()
    The names of Gradle's Configuration for which dependencies should be collected.
    abstract org.gradle.api.provider.Property<String>
    getOnlyArches()
    The supported architectures.
    abstract org.gradle.api.file.RegularFileProperty
    getOutputFile()
    Specifies where to write the resulting json file.

    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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, 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, notCompatibleWithConfigurationCache

  • Constructor Details

    • FlatpakGradleGeneratorTask

      public FlatpakGradleGeneratorTask()
      Create a new instance of the task.

  • Method Details

    • getOutputFile

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getOutputFile()
      Specifies where to write the resulting json file.
      Returns:
      the output file

    • getDownloadDirectory

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getDownloadDirectory()
      Specifies the value for the "dest" attribute in the json file.

      Defaults to "offline-repository".

      Returns:
      the download directory

    • getIncludeConfigurations

      @Input @Optional public abstract org.gradle.api.provider.SetProperty<String> getIncludeConfigurations()
      The names of Gradle's Configuration for which dependencies should be collected.

      Defaults to all project's configurations.

      Returns:
      the included configurations

    • getExcludeConfigurations

      @Input @Optional public abstract org.gradle.api.provider.SetProperty<String> getExcludeConfigurations()
      The names of Gradle's Configuration to exclude from dependency collection.

      Overrides getIncludeConfigurations().

      Returns:
      the excluded configurations

    • getOnlyArches

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getOnlyArches()
      The supported architectures.
      Returns:
      the "only-arches" value that will be added to the generated json entries.

    • apply

      public void apply() throws IOException, ExecutionException, InterruptedException
      Run the flatpakGradleGenerator task.
      Throws:
      ExecutionException - error during execution
      InterruptedException - interrupted during execution
      IOException - error writing json list to output file