Classpath Entry Dialog


  The class path entry dialog is shown when clicking on the  add button in the "Configure Java Invocation" step of the launcher wizard. Upon closing this dialog with the OK button, a new class path entry will be appended to the bottom of the class path list of that step.
  To define a class path entry, you first select the entry type, then check the fail if an error occurs with this class path entry check box in case you want the startup to be terminated if this class path entry is faulty and finally fill out the Detail section of the dialog which is dependent on the selected entry type. The following entry types are available:
  •  Scan directory
    Scan a directory for archives with the extensions *.jar and *.zip to be added to the class path. In the Detail section of the dialog you must choose a directory either by entering the path in the text field or by clicking ... and choosing it with a file chooser.

    Error handling:
    If fail if an error occurs with this class path entry is checked, the application will terminate with an error message if this directory does not exist.

  •  Directory
    Add a directory to the class path. In the Detail section of the dialog you must choose a directory either by entering the path in the text field or by clicking ... and choosing it with a file chooser.

    Error handling:
    If fail if an error occurs with this class path entry is checked, the application will terminate with an error message if this directory does not exist.

  •  Archive
    Add an archive with the extension *.jar or *.zip to the class path. In the Detail section of the dialog you must choose an archive either by entering the path in the text field or by clicking ... and choosing it with a file chooser.

    The last path component can include a * as a placeholder for a frequently changing version number. This is not a wildcard for processing multiple matching paths, rather it is intended for systems like maven where the version number on dependencies is part of the file name and is frequently changed. An example is bin/commons-io-*.jar which will match a file like bin/commons-io-1.0.jar at compile time. This replacement is performed at compile-time and not a runtime.

    Error handling:
    If fail if an error occurs with this class path entry is checked, the application will terminate with an error message if this archive does not exist.

  •  Environment variable
    Add the contents of an environment variable to the class path. In the Detail section of the dialog you must enter the name of an environment variable.

    Error handling:
    If fail if an error occurs with this class path entry is checked, the application will terminate with an error message if this environment variable is not defined.

  •  Compiler variable
    Reads the value of a compiler variable, splits it with the configured path separator and adds that list of JAR files to the class path. Note that the compiler variable must be defined, otherwise the build will fail and you have to specify the plain name of the compiler variable, without any surrounding variable replacement syntax.

    For the separator, the compiler variable ${compiler:sys.pathlistSeparator} can be used to separate path lists with ; on Windows and : on Unix. The separator is interpreted as a regular expression, so you can use \n for separating files with new lines, for example.

    The JAR files in the compiler variable must already be present in the distribution tree, they are not added automatically. To change the directory where files should be resolved within the distribution tree, select the Relative path prefix check box and enter a relative path. The relative path can be empty in which case the JAR files must be located directly in the installation directory. If you pass a list of absolute files in the compiler variable, you must select the Relative path prefix check box, otherwise the build will fail.

    Error handling:
    If fail if an error occurs with this class path entry is checked, the application will terminate with an error message if any of the archives that are referenced in the compiler variable are not found.

Except for the "Environment variable" and "Compiler variable" classpath types, you can use environment variables in the text field with the following syntax: ${VARIABLE_NAME} where you replace VARIABLE_NAME with the desired environment variable.

Note that for path selections by means of a file chooser (... buttons), install4j will try to convert the path to be relative to the distribution source directory.