Class AbstractJPackageTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.danlewis783.jpackage.AbstractJPackageTask
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>
Direct Known Subclasses:
JPackageImageTask, JPackageInstallerTask
@DisableCachingByDefault(because="Abstract base type; the concrete tasks declare their own cacheability") public abstract class AbstractJPackageTask extends org.gradle.api.DefaultTask
Properties and helpers shared by the tasks that invoke jpackage.

  • 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
    AbstractJPackageTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static void
    addIfPresent(List<String> command, String option, org.gradle.api.provider.Property<String> value)
     
    protected void
    checkNumericVersionOnWindows()
    jpackage on Windows rejects versions with non-numeric components, e.g.
    abstract org.gradle.api.provider.Property<String>
    getAppDescription()
     
    abstract org.gradle.api.provider.Property<String>
    getAppName()
     
    abstract org.gradle.api.provider.Property<String>
    getAppVersion()
     
    abstract org.gradle.api.file.DirectoryProperty
    getDestinationDir()
     
    protected abstract org.gradle.process.ExecOperations
    getExecOperations()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getExtraArgs()
     
    protected abstract org.gradle.api.file.FileSystemOperations
    getFileSystemOperations()
     
    abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher>
    getJavaLauncher()
    Launcher of the JDK whose jpackage tool is invoked.
    String
    getPlatform()
    OS family and architecture; jpackage output is platform-specific, so it keys the build cache.
    abstract org.gradle.api.file.DirectoryProperty
    getResourceDir()
     
    abstract org.gradle.api.provider.Property<String>
    getVendor()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getVerbose()
     
    protected List<String>
    newCommand(File jpackage, String type)
    Starts a jpackage command line with the options common to all invocations.
    protected File
    resolveJpackage()
    Resolves the jpackage executable of the configured toolchain, failing if it is missing.
    protected void
    runJpackage(List<String> command)
    Appends the extra arguments and --verbose, then runs the jpackage command.

    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, getLoggingManager, 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 Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • AbstractJPackageTask

      public AbstractJPackageTask()

  • Method Details

    • getAppName

      @Input public abstract org.gradle.api.provider.Property<String> getAppName()

    • getAppVersion

      @Input public abstract org.gradle.api.provider.Property<String> getAppVersion()

    • getVendor

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getVendor()

    • getAppDescription

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getAppDescription()

    • getResourceDir

      @InputDirectory @Optional @PathSensitive(RELATIVE) public abstract org.gradle.api.file.DirectoryProperty getResourceDir()

    • getExtraArgs

      @Input public abstract org.gradle.api.provider.ListProperty<String> getExtraArgs()

    • getVerbose

      @Console public abstract org.gradle.api.provider.Property<Boolean> getVerbose()

    • getJavaLauncher

      public abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher> getJavaLauncher()
      Launcher of the JDK whose jpackage tool is invoked.

    • getDestinationDir

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getDestinationDir()

    • getPlatform

      @Input public String getPlatform()
      OS family and architecture; jpackage output is platform-specific, so it keys the build cache.

    • getExecOperations

      @Inject protected abstract org.gradle.process.ExecOperations getExecOperations()

    • getFileSystemOperations

      @Inject protected abstract org.gradle.api.file.FileSystemOperations getFileSystemOperations()

    • resolveJpackage

      protected File resolveJpackage()
      Resolves the jpackage executable of the configured toolchain, failing if it is missing.

    • checkNumericVersionOnWindows

      protected void checkNumericVersionOnWindows()
      jpackage on Windows rejects versions with non-numeric components, e.g. 1.0-SNAPSHOT.

    • newCommand

      protected List<String> newCommand(File jpackage, String type)
      Starts a jpackage command line with the options common to all invocations.
      Parameters:
      type - the --type value, or null for jpackage's platform default

    • runJpackage

      protected void runJpackage(List<String> command)
      Appends the extra arguments and --verbose, then runs the jpackage command.

    • addIfPresent

      protected static void addIfPresent(List<String> command, String option, org.gradle.api.provider.Property<String> value)