Module app.supernaut.fx

Package app.supernaut.fx

Class FxLauncherAbstract

java.lang.Object

app.supernaut.fx.FxLauncherAbstract

All Implemented Interfaces:

FxLauncher

Direct Known Subclasses:

MicronautFxLauncher, SimpleFxLauncher

public abstract class FxLauncherAbstract
extends Object
implements FxLauncher

Base JavaFX implementation of FxLauncher. This implementation provides the following functionality:

1. Starts OpenJFX applications.
2. Constructor provides an option to start BackgroundApp on a new thread (this allows the BackgroundApp and the OpenJFX ApplicationDelegate to initialize in parallel.)
3. Implements FxLauncher.launchAsync(java.lang.String[], java.lang.Class<? extends app.supernaut.fx.ApplicationDelegate>, java.lang.Class<? extends app.supernaut.BackgroundApp>) which initializes the OpenJFX ApplicationDelegate on a new thread. This is not needed for a typical, packaged OpenJFX application which can just call FxLauncher.launch(java.lang.String[], java.lang.Class<? extends app.supernaut.fx.ApplicationDelegate>, java.lang.Class<? extends app.supernaut.BackgroundApp>) from its static main(), but is useful in various testing scenarios.
4. Defines the FxLauncherAbstract.AppFactory interface for constructing the BackgroundApp and ApplicationDelegate. This allows subclasses (or callers) to provide their own implementation of the application creation logic. The AppFactory interface was designed to allow usage of Dependency Injection frameworks like Micronaut to create dependency-injected implementations of ApplicationDelegate and BackgroundApp. The AppFactory interface was also designed to be lazily-instantiated so the AppFactory (dependency-injection framework) can initialize in parallel to OpenJFX.
5. Uses the same AppFactory (dependency-injection context) to initialize the ApplicationDelegate and Background application. A CountDownLatch is used to make sure the AppFactory (which may be initialized on another thread along with the BackgroundApp) is ready when OpenJfxProxyApplication calls createAppDelegate(Application proxyApplication).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FxLauncherAbstract.AppFactory	Interface that can be used to create and pre-initialize ApplicationDelegate and BackgroundApp.
static class	FxLauncherAbstract.DefaultAppFactory	Default implementation of AppFactory.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CompletableFuture<ApplicationDelegate>	futureAppDelegate	This future returns an initialized ApplicationDelegate
protected final CompletableFuture<BackgroundApp>	futureBackgroundApp	This future returns an initialized BackgroundApp

Constructor Summary

Constructors

Constructor	Description
FxLauncherAbstract(Supplier<FxLauncherAbstract.AppFactory> appFactorySupplier, boolean initializeBackgroundAppOnNewThread)	Construct an Asynchronous Launcher that works with OpenJFX.

Method Summary

Modifier and Type	Method	Description
ApplicationDelegate	createAppDelegate(javafx.application.Application proxyApplication)	Called by OpenJfxProxyApplication to create its delegate ApplicationDelegate object.
CompletableFuture<ApplicationDelegate>	getAppDelegate()	Get a future that will be completed when the ApplicationDelegate is initialized.
CompletableFuture<BackgroundApp>	getBackgroundApp()	Get a future that will be completed when the Background app is initialized.
void	launch(String[] args, Class<? extends ApplicationDelegate> appDelegate)	Launch and run the application on the current thread.
void	launch(String[] args, Class<? extends ApplicationDelegate> appDelegate, Class<? extends BackgroundApp> backgroundApp)	Launch and run the application on the current thread.
CompletableFuture<ApplicationDelegate>	launchAsync(String[] args, Class<? extends ApplicationDelegate> appDelegate, Class<? extends BackgroundApp> backgroundApp)	Launch and run the application on a newly created thread.

Methods inherited from class java.lang.Object

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

Methods inherited from interface app.supernaut.fx.FxLauncher

name

Field Details

futureBackgroundApp

protected final CompletableFuture<BackgroundApp> futureBackgroundApp

This future returns an initialized BackgroundApp

futureAppDelegate

protected final CompletableFuture<ApplicationDelegate> futureAppDelegate

This future returns an initialized ApplicationDelegate

Constructor Details

FxLauncherAbstract

public FxLauncherAbstract(Supplier<FxLauncherAbstract.AppFactory> appFactorySupplier,
 boolean initializeBackgroundAppOnNewThread)

Construct an Asynchronous Launcher that works with OpenJFX.

Parameters:

appFactorySupplier - A Supplier that will lazily instantiate an AppFactory.

initializeBackgroundAppOnNewThread - If true, initializes appFactorySupplier and BackgroundApp on new thread, if false start them on calling thread (typically the main thread)

Method Details

launchAsync

public CompletableFuture<ApplicationDelegate> launchAsync(String[] args,
 Class<? extends ApplicationDelegate> appDelegate,
 Class<? extends BackgroundApp> backgroundApp)

Launch and run the application on a newly created thread. This method is useful for testing and possibly for other application startup scenarios.

Specified by:

launchAsync in interface FxLauncher

Parameters:

args - command-line args

appDelegate - class object for ApplicationDelegate

backgroundApp - class object for BackgroundApp

Returns:

A future that is completed when ApplicationDelegate app is initialized

launch

public void launch(String[] args,
 Class<? extends ApplicationDelegate> appDelegate,
 Class<? extends BackgroundApp> backgroundApp)

Launch and run the application on the current thread. Does not return until after ApplicationDelegate closes.

Specified by:

launch in interface FxLauncher

Parameters:

args - command-line args

appDelegate - class object for ApplicationDelegate

backgroundApp - class object for BackgroundApp

launch

public void launch(String[] args,
 Class<? extends ApplicationDelegate> appDelegate)

Launch and run the application on the current thread. Uses default/no-op background application. Does not return until after ApplicationDelegate closes.

Specified by:

launch in interface FxLauncher

Parameters:

args - command-line args

appDelegate - class object for ApplicationDelegate

createAppDelegate

public ApplicationDelegate createAppDelegate(javafx.application.Application proxyApplication)

Called by OpenJfxProxyApplication to create its delegate ApplicationDelegate object. Waits on a CountDownLatch to make sure the AppFactory is ready.

Specified by:

createAppDelegate in interface FxLauncher

Parameters:

proxyApplication - The calling instance of OpenJfxProxyApplication

Returns:

The newly constructed OpenJFX-compatible ApplicationDelegate

getAppDelegate

public CompletableFuture<ApplicationDelegate> getAppDelegate()

Get a future that will be completed when the ApplicationDelegate is initialized.

Specified by:

getAppDelegate in interface FxLauncher

Returns:

A future that is completed when ApplicationDelegate is initialized

getBackgroundApp

public CompletableFuture<BackgroundApp> getBackgroundApp()

Get a future that will be completed when the Background app is initialized.

Specified by:

getBackgroundApp in interface FxLauncher

Returns:

A future that is completed when Background app is initialized