moe.tristan.easyfxml.model.beanmanagement

Class AbstractInstanceManager<TYPE_COMMON_INST,TYPE_ACTUAL_INST,TYPE_SELECTOR>

java.lang.Object

moe.tristan.easyfxml.model.beanmanagement.AbstractInstanceManager<TYPE_COMMON_INST,TYPE_ACTUAL_INST,TYPE_SELECTOR>

Direct Known Subclasses:

ControllerManager, StageManager

public abstract class AbstractInstanceManager<TYPE_COMMON_INST,TYPE_ACTUAL_INST,TYPE_SELECTOR>
extends Object

This class is aimed at helping you store references to various kinds of class instances.

We distinguish two types of instances :

- Single = only 1 instance of it is ever active at the same time)

- Multiple/Prototype = any number of instances active at the same time

In case all is well, you only use Single and getting the instance is as easy as providing the instance that it is a children of.

In case you have multiple instances for the same parent type, we cannot keep doing that. This is why we need to make sure we can store them in an easy way that can allow distinction between those when needed afterwards. See the registerMultiple(Object, Object, Object) method for that.

Constructor Summary

Constructors

Constructor and Description
AbstractInstanceManager()

Method Summary

Modifier and Type	Method and Description
List<TYPE_ACTUAL_INST>	getAll(TYPE_COMMON_INST parent)
io.vavr.control.Option<TYPE_ACTUAL_INST>	getMultiple(TYPE_COMMON_INST parent, TYPE_SELECTOR selector) Tries to find the instance you look for.
List<TYPE_ACTUAL_INST>	getMultiples(TYPE_COMMON_INST parent)
io.vavr.control.Option<TYPE_ACTUAL_INST>	getSingle(TYPE_COMMON_INST parent)
Map.Entry<TYPE_SELECTOR,TYPE_ACTUAL_INST>	registerMultiple(TYPE_COMMON_INST parent, TYPE_SELECTOR selector, TYPE_ACTUAL_INST instance) This method stores your instances in a ConcurrentHashMap that looks like this : |-- CommonInst1 -- | |-- Selector1 -> Instance 1 of class TYPE_ACTUAL_INST | |-- Selector2 -> Instance 2 of class TYPE_ACTUAL_INST | |-- CommonInst2 -- | |-- Selector# -> Instance # of class TYPE_ACTUAL_INST | ... | |-- SelectorN -> Instance N of class TYPE_ACTUAL_INST ... |
TYPE_ACTUAL_INST	registerSingle(TYPE_COMMON_INST parent, TYPE_ACTUAL_INST instance) Registers a single instance of type TYPE_ACTUAL_INST under the TYPE_COMMON_INST category.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInstanceManager

public AbstractInstanceManager()

Method Detail

registerSingle

public TYPE_ACTUAL_INST registerSingle(TYPE_COMMON_INST parent,
                                       TYPE_ACTUAL_INST instance)

Registers a single instance of type TYPE_ACTUAL_INST under the TYPE_COMMON_INST category.

Parameters:

parent - The parent of this instance

instance - The instance to register

Returns:

The instance registered

registerMultiple

public Map.Entry<TYPE_SELECTOR,TYPE_ACTUAL_INST> registerMultiple(TYPE_COMMON_INST parent,
                                                                  TYPE_SELECTOR selector,
                                                                  TYPE_ACTUAL_INST instance)

This method stores your instances in a ConcurrentHashMap that looks like this :
|-- CommonInst1 --
| |-- Selector1 -> Instance 1 of class TYPE_ACTUAL_INST
| |-- Selector2 -> Instance 2 of class TYPE_ACTUAL_INST
|
|-- CommonInst2 --
| |-- Selector# -> Instance # of class TYPE_ACTUAL_INST
| ...
| |-- SelectorN -> Instance N of class TYPE_ACTUAL_INST
...
|

The point is that "selectors" are anything you want them to be, whether it be the hashcode of the instance (but you won't be able to access it easily later), or some kind of related Node. Whatever fits your model in the best way.

Be wary of collisions (i.e. Instance 1 and 2 having the same selector) as it replaces instances in case of collision.

You are responsible for providing correct and non-colliding selectors.

Parameters:

parent - An instance, typically an enum member

selector - The selector that you have to provide to recover this particular instance later

instance - The instance to save.

Returns:

A map entry containing the selector and the controller registered in case you need it.

Throws:

RuntimeException - in case there was an error in saving the instance.

getMultiple

public io.vavr.control.Option<TYPE_ACTUAL_INST> getMultiple(TYPE_COMMON_INST parent,
                                                            TYPE_SELECTOR selector)

Tries to find the instance you look for. Returns an Option (similar to Optional) that either contains Option.Some (found) or Option.None (not found/exception was thrown).

Look at Option for information on how to use it.

Parameters:

parent - The instance who's children you look for.

selector - The selector previously used in #registerMultiple(TYPE_COMMON_INST, TYPE_SELECTOR, TYPE_ACTUAL_INST).

Returns:

The Option that either contains it (Option.Some) or is empty. That is, Option.None, which means that it was not found or at some point in the hierarchy there has been an exception).

getAll

public List<TYPE_ACTUAL_INST> getAll(TYPE_COMMON_INST parent)

Parameters:

parent - The parent instance of all the nodes sought

Returns:

All the nodes registered under the given parent instance or an empty list if there are none.

getMultiples

public List<TYPE_ACTUAL_INST> getMultiples(TYPE_COMMON_INST parent)

Parameters:

parent - The parent instance of all the nodes sought

Returns:

All the multiple-type nodes under the given parent instance, or an empty list if there are none.

getSingle

public io.vavr.control.Option<TYPE_ACTUAL_INST> getSingle(TYPE_COMMON_INST parent)

Parameters:

parent - The parent instance of the node sought

Returns:

Option.Some filled with the unique node of single-type under this instance, or Option.None.