Class InstallerOptions

java.lang.Object
io.github.danlewis783.jpackage.InstallerOptions
public abstract class InstallerOptions extends Object
Options for building native installers from the application image.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InstallerOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getAboutUrl()
    URL shown in the installer/uninstall entry (--about-url).
    abstract org.gradle.api.provider.ListProperty<String>
    getExtraArgs()
    Extra arguments appended verbatim to each installer jpackage invocation.
    abstract org.gradle.api.provider.Property<String>
    getInstallDir()
    Installation directory.
    abstract org.gradle.api.file.RegularFileProperty
    getLicenseFile()
    License file displayed by the installer (--license-file).
    abstract org.gradle.api.provider.Property<Boolean>
    getSideBySide()
    When true (the default), different versions of the application can be installed side by side: the Windows upgrade UUID is derived from the app name and version, and the install directory defaults to <appName>/<appVersion>.
    abstract org.gradle.api.provider.ListProperty<String>
    getTypes()
    Installer types to produce, e.g.
    abstract org.gradle.api.provider.Property<Boolean>
    getWinDirChooser()
    Lets the user choose the install directory (--win-dir-chooser).
    abstract org.gradle.api.provider.Property<Boolean>
    getWinMenu()
    Adds a Start Menu entry (--win-menu).
    abstract org.gradle.api.provider.Property<String>
    getWinMenuGroup()
    Start Menu group (folder) name (--win-menu-group).
    abstract org.gradle.api.provider.Property<Boolean>
    getWinPerUserInstall()
    Installs per-user instead of per-machine (--win-per-user-install).
    abstract org.gradle.api.provider.Property<Boolean>
    getWinShortcut()
    Adds a desktop shortcut (--win-shortcut).
    abstract org.gradle.api.provider.Property<Boolean>
    getWinShortcutPrompt()
    Lets the user choose shortcuts during install (--win-shortcut-prompt).
    abstract org.gradle.api.provider.Property<String>
    getWinUpgradeUuid()
    Explicit MSI upgrade UUID (--win-upgrade-uuid).

    Methods inherited from class Object

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

  • Constructor Details

    • InstallerOptions

      public InstallerOptions()

  • Method Details

    • getTypes

      public abstract org.gradle.api.provider.ListProperty<String> getTypes()
      Installer types to produce, e.g. ["msi"] or ["msi", "exe"]. Defaults to ["msi"] on Windows and the platform default elsewhere. Building msi/exe requires the WiX Toolset on the PATH.

    • getLicenseFile

      public abstract org.gradle.api.file.RegularFileProperty getLicenseFile()
      License file displayed by the installer (--license-file).

    • getAboutUrl

      public abstract org.gradle.api.provider.Property<String> getAboutUrl()
      URL shown in the installer/uninstall entry (--about-url).

    • getInstallDir

      public abstract org.gradle.api.provider.Property<String> getInstallDir()
      Installation directory. On Windows this is a relative sub-path below the default installation location, e.g. "MyApp/1.2.3". When sideBySide is enabled (the default) this defaults to <appName>/<appVersion>.

    • getSideBySide

      public abstract org.gradle.api.provider.Property<Boolean> getSideBySide()
      When true (the default), different versions of the application can be installed side by side: the Windows upgrade UUID is derived from the app name and version, and the install directory defaults to <appName>/<appVersion>. Installing a new version then does not remove the previous one.

      When false, jpackage's default upgrade UUID (stable across versions) is used, so installing a newer version upgrades/replaces the older one.

    • getWinMenu

      public abstract org.gradle.api.provider.Property<Boolean> getWinMenu()
      Adds a Start Menu entry (--win-menu). Defaults to true.

    • getWinMenuGroup

      public abstract org.gradle.api.provider.Property<String> getWinMenuGroup()
      Start Menu group (folder) name (--win-menu-group). Defaults to the app name.

    • getWinShortcut

      public abstract org.gradle.api.provider.Property<Boolean> getWinShortcut()
      Adds a desktop shortcut (--win-shortcut). Defaults to true.

    • getWinShortcutPrompt

      public abstract org.gradle.api.provider.Property<Boolean> getWinShortcutPrompt()
      Lets the user choose shortcuts during install (--win-shortcut-prompt).

    • getWinDirChooser

      public abstract org.gradle.api.provider.Property<Boolean> getWinDirChooser()
      Lets the user choose the install directory (--win-dir-chooser).

    • getWinPerUserInstall

      public abstract org.gradle.api.provider.Property<Boolean> getWinPerUserInstall()
      Installs per-user instead of per-machine (--win-per-user-install).

    • getWinUpgradeUuid

      public abstract org.gradle.api.provider.Property<String> getWinUpgradeUuid()
      Explicit MSI upgrade UUID (--win-upgrade-uuid). Setting this overrides the sideBySide derivation.

    • getExtraArgs

      public abstract org.gradle.api.provider.ListProperty<String> getExtraArgs()
      Extra arguments appended verbatim to each installer jpackage invocation.