Container (org.macroing.cit.ioc API)

java.lang.Object
- org.macroing.cit.ioc.container.Container

```
public final class Container
extends java.lang.Object
```
A Container is a container in the sense of Inversion of Control (IoC).
Its primary responsibility is to govern the life-cycle of a modular application. It can be started and it can be stopped.
The order in which Components are started and stopped, is the responsibility of the ComponentLoaders that loads them. Stopping will be done in the reverse order of the order they were loaded.
The responsibility of configuring Components are handled by one or more ComponentConfigurators. One such configuration could be Dependency Injection (DI), which is not the responsibility of any given Component.
Another useful feature of a Container is filtering. To filter out which Components are eligible to start, use one or more ComponentFilters.
To get started using this API, consider the following example:
```
 
 Container container = new Container();
 container.addComponentConfigurator(new MyComponentConfigurator());
 container.addComponentFilter(new MyComponentFilter());
 container.addComponentLoader(new MyComponentLoader());
 container.addContainerObserver(new MyContainerObserver());
 container.start();
 
 
```
This class is not thread-safe.
Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors
Constructor and Description

Container()
Constructs a new empty Container instance.

Constructors
Constructor and Description
`Container()` Constructs a new empty `Container` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addComponentConfigurator(ComponentConfigurator componentConfigurator)` Adds `componentConfigurator`, if not present.
`boolean`	`addComponentFilter(ComponentFilter componentFilter)` Adds `componentFilter`, if not present.
`boolean`	`addComponentLoader(ComponentLoader componentLoader)` Adds `componentLoader`, if not present.
`boolean`	`addContainerObserver(ContainerObserver containerObserver)` Adds `containerObserver`, if not present.
`boolean`	`isRunning()` Returns `true` if, and only if, this `Container` instance is currently running, `false` otherwise.
`boolean`	`removeComponentConfigurator(ComponentConfigurator componentConfigurator)` Removes `componentConfigurator`, if present.
`boolean`	`removeComponentFilter(ComponentFilter componentFilter)` Removes `componentFilter`, if present.
`boolean`	`removeComponentLoader(ComponentLoader componentLoader)` Removes `componentLoader`, if present.
`boolean`	`removeContainerObserver(ContainerObserver containerObserver)` Removes `containerObserver`, if present.
`boolean`	`start()` Starts this `Container` instance, if not already running.
`boolean`	`stop()` Stops this `Container` instance, if it's currently running.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Container
```
public Container()
```
    Constructs a new empty Container instance.
    This new Container instance will not be started automatically.
- Method Detail
  - addComponentConfigurator
```
public boolean addComponentConfigurator(ComponentConfigurator componentConfigurator)
```
    Adds componentConfigurator, if not present.
    Returns true if, and only if, componentConfigurator was successfully added, false otherwise.
    If componentConfigurator is null, a NullPointerException will be thrown.
    
    Parameters:
    
    componentConfigurator - the ComponentConfigurator to add
    
    Returns:
    
    true if, and only if, componentConfigurator was successfully added, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, componentConfigurator is null
  - addComponentFilter
```
public boolean addComponentFilter(ComponentFilter componentFilter)
```
    Adds componentFilter, if not present.
    Returns true if, and only if, componentFilter was successfully added, false otherwise.
    If componentFilter is null, a NullPointerException will be thrown.
    
    Parameters:
    
    componentFilter - the ComponentFilter to add
    
    Returns:
    
    true if, and only if, componentFilter was successfully added, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, componentFilter is null
  - addComponentLoader
```
public boolean addComponentLoader(ComponentLoader componentLoader)
```
    Adds componentLoader, if not present.
    Returns true if, and only if, componentLoader was successfully added, false otherwise.
    If componentLoader is null, a NullPointerException will be thrown.
    
    Parameters:
    
    componentLoader - the ComponentLoader to add
    
    Returns:
    
    true if, and only if, componentLoader was successfully added, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, componentLoader is null
  - addContainerObserver
```
public boolean addContainerObserver(ContainerObserver containerObserver)
```
    Adds containerObserver, if not present.
    Returns true if, and only if, containerObserver was successfully added, false otherwise.
    If containerObserver is null, a NullPointerException will be thrown.
    
    Parameters:
    
    containerObserver - the ContainerObserver to add
    
    Returns:
    
    true if, and only if, containerObserver was successfully added, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, containerObserver is null
  - isRunning
```
public boolean isRunning()
```
    Returns true if, and only if, this Container instance is currently running, false otherwise.
    
    Returns:
    
    true if, and only if, this Container instance is currently running, false otherwise
  - removeComponentConfigurator
```
public boolean removeComponentConfigurator(ComponentConfigurator componentConfigurator)
```
    Removes componentConfigurator, if present.
    Returns true if, and only if, componentConfigurator was successfully removed, false otherwise.
    If componentConfigurator is null, a NullPointerException will be thrown.
    
    Parameters:
    
    componentConfigurator - the ComponentConfigurator to remove
    
    Returns:
    
    true if, and only if, componentConfigurator was successfully removed, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, componentConfigurator is null
  - removeComponentFilter
```
public boolean removeComponentFilter(ComponentFilter componentFilter)
```
    Removes componentFilter, if present.
    Returns true if, and only if, componentFilter was successfully removed, false otherwise.
    If componentFilter is null, a NullPointerException will be thrown.
    
    Parameters:
    
    componentFilter - the ComponentFilter to remove
    
    Returns:
    
    true if, and only if, componentFilter was successfully removed, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, componentFilter is null
  - removeComponentLoader
```
public boolean removeComponentLoader(ComponentLoader componentLoader)
```
    Removes componentLoader, if present.
    Returns true if, and only if, componentLoader was successfully removed, false otherwise.
    If componentLoader is null, a NullPointerException will be thrown.
    
    Parameters:
    
    componentLoader - the ComponentLoader to remove
    
    Returns:
    
    true if, and only if, componentLoader was successfully removed, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, componentLoader is null
  - removeContainerObserver
```
public boolean removeContainerObserver(ContainerObserver containerObserver)
```
    Removes containerObserver, if present.
    Returns true if, and only if, containerObserver was successfully removed, false otherwise.
    If containerObserver is null, a NullPointerException will be thrown.
    
    Parameters:
    
    containerObserver - the ContainerObserver to remove
    
    Returns:
    
    true if, and only if, containerObserver was successfully removed, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, containerObserver is null
  - start
```
public boolean start()
```
    Starts this Container instance, if not already running.
    If this Container instance is successfully started, all currently added ComponentLoaders will be informed to load their Components.
    When a Component has been loaded, passed filtering and, optionally, been configured, it will be started.
    The order in which a Component is started, is first and foremost dependent on the order it was loaded. But also the filtering and configuration operations that are performed in sequence play a crucial role.
    All currently added ContainerObservers will be notified of all Components that are successfully started.
    If an Exception is caught while loading, filtering, configuring or starting Components, all currently added ContainerObservers will be notified of this.
    Returns true if, and only if, this Container instance was successfully started, false otherwise.
    
    Returns:
    
    true if, and only if, this Container instance was successfully started, false otherwise
  - stop
```
public boolean stop()
```
    Stops this Container instance, if it's currently running.
    If this Container instance is successfully stopped, all currently loaded Components will be stopped in the reverse order of the order they were loaded.
    If an Exception is caught while stopping a Component, all currently added ContainerObservers will be notified of this.
    Returns true if, and only if, this Container instance was successfully stopped, false otherwise.
    
    Returns:
    
    true if, and only if, this Container instance was successfully stopped, false otherwise

Class Container

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Container

Method Detail

addComponentConfigurator

addComponentFilter

addComponentLoader

addContainerObserver

isRunning

removeComponentConfigurator

removeComponentFilter

removeComponentLoader

removeContainerObserver

start

stop