Class JPackageImageTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.danlewis783.jpackage.JPackageImageTask
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>
@CacheableTask public abstract class JPackageImageTask extends org.gradle.api.DefaultTask
Runs jpackage --type app-image to produce a self-contained application image (native launcher plus bundled Java runtime), then copies the configured documentation files into the image root.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createAppImage()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getAddModules()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getAppArguments()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getAppContent()
    Jars packaged as the application: the main jar and its runtime classpath.
    abstract org.gradle.api.provider.Property<String>
    getAppDescription()
     
    org.gradle.api.provider.Provider<org.gradle.api.file.Directory>
    getAppImageDirectory()
    The application image directory produced by this task.
    abstract org.gradle.api.provider.Property<String>
    getAppName()
     
    abstract org.gradle.api.provider.Property<String>
    getAppVersion()
     
    abstract org.gradle.api.provider.Property<String>
    getCopyright()
     
    abstract org.gradle.api.file.DirectoryProperty
    getDestinationDir()
    Directory the app image is created in; the image itself is <dest>/<appName>.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getDocFiles()
    Files copied into the root of the application image after jpackage runs.
    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.file.RegularFileProperty
    getIcon()
     
    abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher>
    getJavaLauncher()
    Launcher of the JDK whose jpackage tool is invoked.
    abstract org.gradle.api.provider.ListProperty<String>
    getJavaOptions()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getJlinkOptions()
     
    abstract org.gradle.api.provider.Property<String>
    getMainClass()
     
    abstract org.gradle.api.provider.Property<String>
    getMainJarName()
    File name of the main jar within getAppContent().
    abstract org.gradle.api.file.DirectoryProperty
    getResourceDir()
     
    abstract org.gradle.api.file.DirectoryProperty
    getRuntimeImage()
     
    abstract org.gradle.api.provider.Property<String>
    getVendor()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getVerbose()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getWinConsole()
     

    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 Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • JPackageImageTask

      public JPackageImageTask()

  • Method Details

    • getAppContent

      @InputFiles @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.ConfigurableFileCollection getAppContent()
      Jars packaged as the application: the main jar and its runtime classpath.

    • getAppName

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

    • getAppVersion

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

    • getMainClass

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

    • getMainJarName

      @Input public abstract org.gradle.api.provider.Property<String> getMainJarName()
      File name of the main jar within getAppContent().

    • getVendor

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

    • getAppDescription

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

    • getCopyright

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

    • getIcon

      @InputFile @Optional @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.RegularFileProperty getIcon()

    • getWinConsole

      @Input public abstract org.gradle.api.provider.Property<Boolean> getWinConsole()

    • getJavaOptions

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

    • getAppArguments

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

    • getDocFiles

      @InputFiles @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getDocFiles()
      Files copied into the root of the application image after jpackage runs.

    • getRuntimeImage

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

    • getResourceDir

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

    • getAddModules

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

    • getJlinkOptions

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

    • 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()
      Directory the app image is created in; the image itself is <dest>/<appName>.

    • getAppImageDirectory

      @Internal public org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getAppImageDirectory()
      The application image directory produced by this task.

    • getExecOperations

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

    • getFileSystemOperations

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

    • createAppImage

      public void createAppImage()