Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- apply(Project) - Method in class io.github.danlewis783.jpackage.JPackagePlugin
C
- createAppImage() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- createInstallers() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
D
- DEV_INSTALL_TASK_NAME - Static variable in class io.github.danlewis783.jpackage.JPackagePlugin
E
- EXTENSION_NAME - Static variable in class io.github.danlewis783.jpackage.JPackagePlugin
G
- getAboutUrl() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
URL shown in the installer/uninstall entry (
--about-url). - getAboutUrl() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getAddModules() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Modules linked into the generated runtime image (
--add-modules). - getAddModules() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getAppArguments() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getAppContent() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
-
Jars packaged as the application: the main jar and its runtime classpath.
- getAppDescription() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getAppImageDirectory() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
-
The application image directory produced by this task.
- getAppImageDirectory() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
-
The application image to package, as produced by
JPackageImageTask. - getAppName() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Application name; also the launcher name.
- getAppName() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getAppName() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getAppVersion() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Application version.
- getAppVersion() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getAppVersion() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getArguments() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Default command-line arguments passed to the main class (
--arguments). - getCopyright() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Copyright string embedded in the application.
- getCopyright() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getDescription() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Description shown in the app metadata and installers.
- getDestinationDir() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
-
Directory the app image is created in; the image itself is
<dest>/<appName>. - getDestinationDir() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getDevInstallDirectory() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Local directory that
jpackageInstallcopies the application image into, for developer self-use without an installer. - getDocFiles() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Documentation files (README, LICENSE, manuals, ...) copied into the root of the application image.
- getDocFiles() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
-
Files copied into the root of the application image after jpackage runs.
- getExecOperations() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getExecOperations() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getExtraArgs() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Extra arguments appended verbatim to each installer jpackage invocation.
- getExtraArgs() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Extra arguments appended verbatim to the app-image jpackage invocation.
- getExtraArgs() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getExtraArgs() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getFileSystemOperations() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getFileSystemOperations() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getIcon() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Launcher icon (
.icoon Windows,.icnson macOS,.pngon Linux). - getIcon() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getInstallDir() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Installation directory.
- getInstallDir() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getInstaller() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Native installer options used by the
jpackageInstallertask. - getJavaLauncher() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
-
Launcher of the JDK whose
jpackagetool is invoked. - getJavaLauncher() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
-
Launcher of the JDK whose
jpackagetool is invoked. - getJavaOptions() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
JVM options baked into the launcher (
--java-options). - getJavaOptions() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getJlinkOptions() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Options passed to jlink when the runtime image is generated (
--jlink-options). - getJlinkOptions() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getJpackageJdkVersion() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Java major version of the JDK toolchain whose
jpackagetool is used. - getLicenseFile() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
License file displayed by the installer (
--license-file). - getLicenseFile() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getMainClass() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Fully qualified main class of the application.
- getMainClass() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getMainJar() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
File name of the main jar within the packaged input.
- getMainJarName() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
-
File name of the main jar within
JPackageImageTask.getAppContent(). - getResourceDir() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Directory of resources that override jpackage defaults (
--resource-dir). - getResourceDir() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getResourceDir() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getRuntimeImage() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
A pre-built runtime image to bundle instead of one produced by jlink.
- getRuntimeImage() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getSideBySide() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
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>. - getTypes() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Installer types to produce, e.g.
- getTypes() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
-
Installer types to produce; empty means the platform default type.
- getVendor() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Vendor shown in the app metadata and installers.
- getVendor() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getVendor() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getVerbose() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Passes
--verboseto jpackage. - getVerbose() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getVerbose() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinConsole() - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
When
trueon Windows, the launcher opens a console window and connects stdio. - getWinConsole() - Method in class io.github.danlewis783.jpackage.JPackageImageTask
- getWinDirChooser() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Lets the user choose the install directory (
--win-dir-chooser). - getWinDirChooser() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinMenu() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Adds a Start Menu entry (
--win-menu). - getWinMenu() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinMenuGroup() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Start Menu group (folder) name (
--win-menu-group). - getWinMenuGroup() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinPerUserInstall() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Installs per-user instead of per-machine (
--win-per-user-install). - getWinPerUserInstall() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinShortcut() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Adds a desktop shortcut (
--win-shortcut). - getWinShortcut() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinShortcutPrompt() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Lets the user choose shortcuts during install (
--win-shortcut-prompt). - getWinShortcutPrompt() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
- getWinUpgradeUuid() - Method in class io.github.danlewis783.jpackage.InstallerOptions
-
Explicit MSI upgrade UUID (
--win-upgrade-uuid). - getWinUpgradeUuid() - Method in class io.github.danlewis783.jpackage.JPackageInstallerTask
I
- IMAGE_TASK_NAME - Static variable in class io.github.danlewis783.jpackage.JPackagePlugin
- installer(Action) - Method in class io.github.danlewis783.jpackage.JPackageExtension
-
Configures the native installer options.
- INSTALLER_TASK_NAME - Static variable in class io.github.danlewis783.jpackage.JPackagePlugin
- InstallerOptions - Class in io.github.danlewis783.jpackage
-
Options for building native installers from the application image.
- InstallerOptions() - Constructor for class io.github.danlewis783.jpackage.InstallerOptions
- io.github.danlewis783.jpackage - package io.github.danlewis783.jpackage
- io.github.danlewis783.jpackage.internal - package io.github.danlewis783.jpackage.internal
- isMacOs() - Static method in class io.github.danlewis783.jpackage.internal.OsUtil
- isWindows() - Static method in class io.github.danlewis783.jpackage.internal.OsUtil
J
- jpackageExecutable(File) - Static method in class io.github.danlewis783.jpackage.internal.OsUtil
-
Resolves the jpackage executable that lives next to the given
javaexecutable. - JPackageExtension - Class in io.github.danlewis783.jpackage
-
Configuration for packaging a Java application with the
jpackagetool. - JPackageExtension(ObjectFactory) - Constructor for class io.github.danlewis783.jpackage.JPackageExtension
- JPackageImageTask - Class in io.github.danlewis783.jpackage
-
Runs
jpackage --type app-imageto produce a self-contained application image (native launcher plus bundled Java runtime), then copies the configured documentation files into the image root. - JPackageImageTask() - Constructor for class io.github.danlewis783.jpackage.JPackageImageTask
- JPackageInstallerTask - Class in io.github.danlewis783.jpackage
-
Runs
jpackage --type <installer-type> --app-image ...to build native installers from a previously created application image. - JPackageInstallerTask() - Constructor for class io.github.danlewis783.jpackage.JPackageInstallerTask
- JPackagePlugin - Class in io.github.danlewis783.jpackage
-
Packages a Java application with the JDK's
jpackagetool. - JPackagePlugin() - Constructor for class io.github.danlewis783.jpackage.JPackagePlugin
O
- OsUtil - Class in io.github.danlewis783.jpackage.internal
-
Small OS helpers shared by the jpackage tasks.
T
- TASK_GROUP - Static variable in class io.github.danlewis783.jpackage.JPackagePlugin
Z
- ZIP_TASK_NAME - Static variable in class io.github.danlewis783.jpackage.JPackagePlugin
All Classes and Interfaces|All Packages|Constant Field Values