com.cathive.fx.guice

Class GuiceApplication

java.lang.Object

javafx.application.Application

com.cathive.fx.guice.GuiceApplication

public abstract class GuiceApplication
extends javafx.application.Application

A simple replacement for the default JavaFX Application class that utilizes Google Guice for dependency injection.

Author:

Benjamin P. Jung

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

javafx.application.Application.Parameters

Field Summary

Fields inherited from class javafx.application.Application

STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors

Constructor and Description
GuiceApplication()

Method Summary

Modifier and Type	Method and Description
protected com.google.inject.Injector	createInjector(Set<com.google.inject.Module> modules) Internal factory method for creating the the Injector.
com.google.inject.Injector	getInjector() Returns the Google Guice Injector that is used within the context of this JavaFX Application.
void	init() To make sure that the initialization of Guice-based JavaFX application works flawlessly, the original init method of the base JavaFX Application class is overwritten here.
abstract void	init(List<com.google.inject.Module> modules) This method is used to fetch and/or create (Guice) modules necessary to fully construct this application.

Methods inherited from class javafx.application.Application

getHostServices, getParameters, getUserAgentStylesheet, launch, launch, notifyPreloader, setUserAgentStylesheet, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiceApplication

public GuiceApplication()

Method Detail

init

public final void init()
                throws Exception

To make sure that the initialization of Guice-based JavaFX application works flawlessly, the original init method of the base JavaFX Application class is overwritten here.

This class offers it's own method for custom initialization, which will be called during the invocation of this overriden method: init(java.util.List).

Overrides:

init in class javafx.application.Application

Throws:

Exception

init

public abstract void init(List<com.google.inject.Module> modules)
                   throws Exception

This method is used to fetch and/or create (Guice) modules necessary to fully construct this application.

The modules that are initialized in this method and added to the passed List will be used to create the Injector instance that is used in the context of this application.

Parameters:

modules - A list of modules (initially empty) that shall be used to create the injector to be used in the context of this application.

Throws:

Exception - if anything goes wrong during initialization.

See Also:

getInjector()

createInjector

protected com.google.inject.Injector createInjector(Set<com.google.inject.Module> modules)

Internal factory method for creating the the Injector. This method can be overwritten to allow for more control on how the the Injector is created. This method is only called once after the initialization phase.

Parameters:

modules - All modules.

Returns:

The Injector that will be used for the the initialization of this JavaFX Application.

getInjector

public final com.google.inject.Injector getInjector()

Returns the Google Guice Injector that is used within the context of this JavaFX Application.

Returns:

The Guice Injector that has been created during the initialization of this JavaFX Application.

See Also:

init(List)