org.mdiutil.lang.applauncher

Class AppLauncher

java.lang.Object

org.mdiutil.lang.applauncher.AppLauncher

All Implemented Interfaces:

AppLauncherResultType

public abstract class AppLauncher
extends Object
implements AppLauncherResultType

The application launcher class. The launcher will launch a process to start a Java jar file. The supported arguments are:

• The location of the JavaFX libraries if they are required
• The libraries path
• The module paths (the "--add-modules" declarations)
• The "--add-opens" declarations
• The "--add-exports" declarations
• The required Java version
• The specific VM arguments

The launcher will keep the arguments passed on the command-line.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	fromVersion The from required version.
static String	JAVAFXLIB "JAVAFXLIB" : The "JAVAFXLIB" configuration property key.
static String	JAVAHOME "JAVAHOME" : The "JAVAHOME" configuration property key.
static String	LIBPATH "LIBPATH" : The "LIBPATH" configuration property key.
static char	MESSAGE_ERRORS Shows an error message if the launch can not be performed.
static String	MODULEPATH "MODULEPATH" : The "MODULEPATH" configuration property key.
static char	POPUP_ERRORS Shows a popup error window if the launch can not be performed.
static String	REQUIRE_VERSION "REQUIRE_VERSION" : The "REQUIRE_VERSION" configuration property key.
static char	THOW_ERRORS Throws an AppLauncherException if the launch can not be performed.
protected int	toVersion The to required version.
static String	VMARGS "VMARGS" : The "VMARGS" configuration property key.

Fields inherited from interface org.mdiutil.lang.applauncher.AppLauncherResultType

CONFIGURATIONFILE_DONT_EXIST, CONFIGURATIONFILE_UNDEFINED, INCOMPATIBLE_VERSION, LAUNCH_FAILED, LAUNCH_OK, LAUNCHABLE_DONT_EXIST, LAUNCHABLE_UNDEFINED

Constructor Summary

Constructors

Constructor and Description
AppLauncher(String[] args)
AppLauncher(String[] args, char errorReturnType)

Method Summary

Modifier and Type	Method and Description
char	getArguments(List<String> arguments) Fill the list of arguments for the launch.
protected abstract String	getConfigurationFile() Return the name of the configuration file.
protected Set<String>	getCustomProperties() Return the names of the allowed custom properties.
protected abstract String	getLaunchable() Return the name of the jar file to launch.
protected void	requireJavaVersion(String version) Set the required Java version.
protected void	separateCustomArguments(boolean separateCustomArguments) Set if the custom arguments in the configuration file must be separated in two arguments.
protected void	setAddExportsAllUnnamed(String... addExports) Set the array of the content of the --add-exports declaration.
protected void	setAddModules(String addModules) Set the name of the content of the --add-mmodules declaration.
protected void	setAddOpensAllUnnamed(String... addOpens) Set the array of the content of the --add-opens declaration.
protected void	setMainClass(String mainClass) Set the main class.
protected void	setThreaded(boolean isThreaded) Set if the launch is threaded.
protected char	start() Setup the launcher and start the jar file.
protected void	write(String line, boolean isError)

Methods inherited from class java.lang.Object

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

Field Detail

THOW_ERRORS

public static final char THOW_ERRORS

Throws an AppLauncherException if the launch can not be performed.

See Also:

Constant Field Values

MESSAGE_ERRORS

public static final char MESSAGE_ERRORS

Shows an error message if the launch can not be performed.

See Also:

Constant Field Values

POPUP_ERRORS

public static final char POPUP_ERRORS

Shows a popup error window if the launch can not be performed.

See Also:

Constant Field Values

JAVAHOME

public static final String JAVAHOME

"JAVAHOME" : The "JAVAHOME" configuration property key. Specifies the location of the JVM to use for the application to launch.

See Also:

Constant Field Values

JAVAFXLIB

public static final String JAVAFXLIB

"JAVAFXLIB" : The "JAVAFXLIB" configuration property key. Specifies the location of the JavaFX libraries for use to the application to launch.

See Also:

Constant Field Values

MODULEPATH

public static final String MODULEPATH

"MODULEPATH" : The "MODULEPATH" configuration property key. Specifies the "--module-path" argument.

See Also:

Constant Field Values

LIBPATH

public static final String LIBPATH

"LIBPATH" : The "LIBPATH" configuration property key. Specifies the "java.library.path" argument.

See Also:

Constant Field Values

VMARGS

public static final String VMARGS

"VMARGS" : The "VMARGS" configuration property key. Specifies additional VM arguments to use.

See Also:

Constant Field Values

REQUIRE_VERSION

public static final String REQUIRE_VERSION

"REQUIRE_VERSION" : The "REQUIRE_VERSION" configuration property key. Specifies the required JVM version.

See Also:

Constant Field Values

fromVersion

protected int fromVersion

The from required version.

toVersion

protected int toVersion

The to required version.

Constructor Detail

AppLauncher

public AppLauncher(String[] args)

AppLauncher

public AppLauncher(String[] args,
                   char errorReturnType)

Method Detail

getLaunchable

protected abstract String getLaunchable()

Return the name of the jar file to launch.

Returns:

the name of the jar file

getConfigurationFile

protected abstract String getConfigurationFile()

Return the name of the configuration file.

Returns:

the name of the configuration file

requireJavaVersion

protected void requireJavaVersion(String version)

Set the required Java version.

Parameters:

version - the required Java version

separateCustomArguments

protected void separateCustomArguments(boolean separateCustomArguments)

Set if the custom arguments in the configuration file must be separated in two arguments.

Parameters:

separateCustomArguments - true if the custom arguments in the configuration file must be separated in two arguments

setMainClass

protected void setMainClass(String mainClass)

Set the main class.

Parameters:

mainClass - the main class

setAddModules

protected void setAddModules(String addModules)

Set the name of the content of the --add-mmodules declaration. For example: "javafx.controls,javafx.fxml,javafx.graphics,javafx.swing,javafx.web"

Parameters:

addModules - the name of the content of the --add-modules declaration

setAddOpensAllUnnamed

protected void setAddOpensAllUnnamed(String... addOpens)

Set the array of the content of the --add-opens declaration. For example: ["javafx.web/javafx.scene.web"]

Parameters:

addOpens - the array of the content of the --add-opens declaration

setAddExportsAllUnnamed

protected void setAddExportsAllUnnamed(String... addExports)

Set the array of the content of the --add-exports declaration.

Parameters:

addExports - the array of the content of the --add-exports declaration.

getCustomProperties

protected Set<String> getCustomProperties()

Return the names of the allowed custom properties. Return null by default.

Returns:

the names of the allowed custom properties

setThreaded

protected void setThreaded(boolean isThreaded)

Set if the launch is threaded.

Parameters:

isThreaded - true if the launch is threaded

getArguments

public char getArguments(List<String> arguments)

Fill the list of arguments for the launch.

Parameters:

arguments - the initial list, to be filled with the arguments

Returns:

the result

start

protected char start()

Setup the launcher and start the jar file.

Returns:

the result of the start

write

protected void write(String line,
                     boolean isError)