de.saxsys.mvvmfx.internal.MvvmfxApplication Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mvvmFX Show documentation

This module is the core implementation of the framework

The newest version!

package de.saxsys.mvvmfx.internal;

import javafx.application.Application;
import javafx.stage.Stage;

/**
 * This interface defines a common set of methods that the root application classes of extensions of mvvmfx should
 * implement.
 * 
 * The interface is intended as an internal helper to unify the API of the official mvvmFX extensions (Guice and CDI at the
 * moment). It is not intended to be used for other use cases.
 * 
 * A mvvmfx extension has to do the following:
 * 
 * Overwrite {@link Application#init()} method with final. In this method the extension can do some
 * bootstrapping (if needed).
 * Call {@link #initMvvmfx()} as last step in the overwritten init method. The contract is that the
 * {@link #initMvvmfx()} is called when the basic container bootstrapping is done so that the user can do her own
 * initialization in this method.
 * Implement {@link Application#start(Stage)} method. In this method own startup logic can be done (if needed).
 * Call {@link #startMvvmfx(Stage)} as last step in the overwritten start method. Pass the stage instance from the
 * original {@link Application#start(Stage)} method to {@link #startMvvmfx(Stage)}.
 * Implement {@link Application#stop()} method. In this method own shutdown logic can be done (if needed).
 * Call {@link #stopMvvmfx()} as last step in the overwritten stop method.
 * 
 * 
 */
public interface MvvmfxApplication {
	
	/**
	 * This method is called when the javafx application is initialized. See
	 * {@link javafx.application.Application#init()} for more details.
	 * 
	 * @throws Exception
	 */
	default void initMvvmfx() throws Exception {
	}
	
	/**
	 * Override this method with your application startup logic.
	 * 
	 * This method is a wrapper method for javafx's {@link javafx.application.Application#start(javafx.stage.Stage)}.
	 */
	void startMvvmfx(Stage stage) throws Exception;
	
	/**
	 * This method is called when the application should stop. See {@link javafx.application.Application#stop()} for
	 * more details.
	 *
	 * @throws Exception
	 */
	default void stopMvvmfx() throws Exception {
	}
	
}