io.datafx.controller.context.ApplicationContext Maven / Gradle / Ivy
Show all versions of flow Show documentation
/**
* Copyright (c) 2011, 2013, Jonathan Giles, Johan Vos, Hendrik Ebbers
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of DataFX, the website javafxdata.org, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package io.datafx.controller.context;
/**
*
* The application context is the context with the longest life time. For each
* application there is exactly one application context. Because of thois the
* context is designed as a singleton. You can access the context by using the
* {@link #getInstance()} method.
*
*
* How to use a context
* A context has a defined life time and can hold the data model of your
* aplication or of a part of your application. To do so you can easily register
* objects to your context:
*
*
* DataModel model = ...
* context.register(model);
*
* In your controller:
* DataModel model = context.getRegisteredObject(DataModel.class);
*
*
* If you need more than one instance of a class in your context you can simple
* register the by using string based keys:
*
*
* DataModel model1 = ...
* DataModel model2 = ...
* context.register("firstModel", model);
* context.register("secondModel", model);
*
* In your controller:
* DataModel firstModel = context.getRegisteredObject("firstModel");
*
*
* A context can simple used in a controller by injecting the context. DataFX
* provides annotations to inject all different context types:
*
*
*
* "@FXMLApplicationContext"
* ApplicationContext myApplicationContext;
*
*
* By doing so you can easily access all your data in your controller and share
* data between different controllers.
*
*
* @author Hendrik Ebbers
*
*/
public class ApplicationContext extends AbstractContext {
private static ApplicationContext instance;
private ApplicationContext() {
}
/**
* Returns the single instance of the application context (singleton)
* @return single instance of the application context
*/
public static synchronized ApplicationContext getInstance() {
if (instance == null) {
instance = new ApplicationContext();
}
return instance;
}
}