Module io.inverno.tool.buildtools
Package io.inverno.tool.buildtools

Interface PackageApplicationTask.Launcher

Enclosing interface:
PackageApplicationTask
public static interface PackageApplicationTask.Launcher

Parameters describing an application launcher.

Since:
1.4
Author:
Jeremy Kuhn

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<String>
    getAppVersion()
    Returns the application launcher version.
    default Optional<String>
    getArguments()
    Returns the default arguments to pass to the application launcher.
    default Optional<String>
    getDescription()
    Returns the description of the application launcher.
    default Optional<Path>
    getIconPath()
    Returns the path to the application launcher icon file.
    default Optional<String>
    getLinuxAppCategory()
    Returns the group value of the RPM /.spec file or Section value of DEB control file.
    default Optional<String>
    getMainClass()
    Returns the canonical name of the main class executed with the application launcher.
    default Optional<String>
    getModule()
    Returns the name of the module defining the main class executed with the application launcher.
    default Optional<String>
    getName()
    Returns the name of the application launcher.
    default Optional<String>
    getVmOptions()
    Returns the VM options to use when executing the application launcher.
    default boolean
    isAddUnnamedModules()
    Determines whether unnamed modules should be added when executing the application launcher.
    default boolean
    isLauncherAsService()
    Determines whether the application launcher should be registered as a background service-type application.
    default boolean
    isLinuxShortcut()
    Determines whether a shortcut must be created when installing the application launcher.
    default boolean
    isWinConsole()
    Determines whether the application launcher should be started in a console to enable console interaction.
    default boolean
    isWinMenu()
    Determines whether a Start Menu shortcut should be added for the application launcher.
    default boolean
    isWinShortcut()
    Determines whether a shortcut should be created for the application launcher.

  • Method Details

    • getName

      default Optional<String> getName()

      Returns the name of the application launcher.

      Defaults to the project's name.

      Returns:
      an optional returning the launcher name or an empty optional

    • getDescription

      default Optional<String> getDescription()

      Returns the description of the application launcher.

      Returns:
      an optional returning the launcher description or an empty optional

    • getModule

      default Optional<String> getModule()

      Returns the name of the module defining the main class executed with the application launcher.

      Defaults to the project's module.

      Returns:
      an optional returning the name of the module defining the main class or an empty optional

    • getMainClass

      default Optional<String> getMainClass()

      Returns the canonical name of the main class executed with the application launcher.

      If not specified, the task will scan for main classes in the launcher's module and pick the first one it found. Note that this is undeterministic, in case the module defines multiple main classes it is recommended to define main class explicitly.

      Returns:
      an optional returning the canonical name of the main class or an empty optional

    • getVmOptions

      default Optional<String> getVmOptions()

      Returns the VM options to use when executing the application launcher.

      Returns:
      an optional returning the VM options or an empty optional

    • getArguments

      default Optional<String> getArguments()

      Returns the default arguments to pass to the application launcher.

      Returns:
      an opional returning the arguments or an empty optional

    • getIconPath

      default Optional<Path> getIconPath()

      Returns the path to the application launcher icon file.

      Returns:
      an optional returnin the path to the icon file or an empty optional

    • getAppVersion

      default Optional<String> getAppVersion()

      Returns the application launcher version.

      Returns:
      an optional returning the application launcher version or an empty optional

    • isAddUnnamedModules

      default boolean isAddUnnamedModules()

      Determines whether unnamed modules should be added when executing the application launcher.

      Returns:
      true to add unnamed modules, false otherwise

    • isLauncherAsService

      default boolean isLauncherAsService()

      Determines whether the application launcher should be registered as a background service-type application.

      Returns:
      true to create a service-type application launcher, false otherwise

    • isWinConsole

      default boolean isWinConsole()

      Determines whether the application launcher should be started in a console to enable console interaction.

      Returns:
      true to create a console launcher, false otherwise

    • isWinShortcut

      default boolean isWinShortcut()

      Determines whether a shortcut should be created for the application launcher.

      Returns:
      true to create a shortcut, false otherwise

    • isWinMenu

      default boolean isWinMenu()

      Determines whether a Start Menu shortcut should be added for the application launcher.

      Returns:
      true to add a Start Menu shortcut, false otherwise

    • getLinuxAppCategory

      default Optional<String> getLinuxAppCategory()

      Returns the group value of the RPM /.spec file or Section value of DEB control file.

      Returns:
      an optional returning the group value or an empty optional

    • isLinuxShortcut

      default boolean isLinuxShortcut()

      Determines whether a shortcut must be created when installing the application launcher.

      Returns:
      true to create a shortcut, false otherwise