Class Reactor

java.lang.Object

org.refcodes.decoupling.Reactor

public class Reactor
extends Object

A Reactor's instance is used for breaking up dependencies between a Java software system's components or modules, which enables them to be developed and tested independently (dependency injection and inversion of control). The reactor wires components or modules together to form an interacting application. The Reactor uses dependency injection and inversion of control, which are two techniques that help achieve decoupling by allowing components to depend on abstractions instead of concrete implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DependencyBuilder<?>>	_dependencies
protected List<DependencyInterceptor>	_interceptors

Constructor Summary

Constructors

Constructor	Description
Reactor()

Method Summary

Modifier and Type	Method	Description
<T> DependencyBuilder<T>	addDependency(Class<T> aType)	Adds a Dependency to the Reactor which's DependencyBuilder is returned for fluently configuring your Dependency.
<F extends org.refcodes.factory.Factory<T>, T> DependencyBuilder<T>	addDependency(Class<T> aType, F aFactory)	Adds a Dependency fabricated by a factory.
<F extends org.refcodes.factory.Factory<T>, T> DependencyBuilder<T>	addDependency(Class<T> aType, Class<F> aFactory)	Adds a Dependency fabricated by a factory.
<F, T> DependencyBuilder<T>	addDependency(Class<T> aType, Class<F> aDependency, Function<F,T> aFactory)	Adds a Dependency fabricated from factory's context (Dependency).
<T> DependencyBuilder<T>	addDependency(T aInstance)	Adds a Dependency to the Reactor which's DependencyBuilder is returned for fluently configuring your Dependency.
boolean	addInterceptor(DependencyInterceptor aInterceptor)	Adds the given DependencyInterceptor instance.
Context	createContext()	Creates a Context which describes the components and modules wired together by this Reactor.
Context	createContext(Object... aProfiles)	Creates a Context, regarding the provided profiles, which describes the components and modules wired together by this Reactor.
Context	createContext(String... aProfiles)	Creates a Context, regarding the provided profiles, which describes the components and modules wired together by this Reactor.
boolean	hasInterceptor(DependencyInterceptor aInterceptor)	Tests whether the given DependencyInterceptor instance has been added.
protected <T> T	intercept(T aInstance, Dependency<T> aDependency)	Invokes all registered DependencyInterceptor instances for the given Dependency declaration's instance for intercepting purposes.
boolean	removeInterceptor(DependencyInterceptor aInterceptor)	Removes the DependencyInterceptor instance.
protected Context	toContext(Object[] aProfiles)	Hook method to create (and prepare) an empty Context (sub-class).

Methods inherited from class java.lang.Object

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

Field Details

_dependencies

protected List<DependencyBuilder<?>> _dependencies

_interceptors

protected List<DependencyInterceptor> _interceptors

Constructor Details

Reactor

public Reactor()

Method Details

addDependency

public <T> DependencyBuilder<T> addDependency(Class<T> aType)

Adds a Dependency to the Reactor which's DependencyBuilder is returned for fluently configuring your Dependency.

Type Parameters:

T - The type of the Dependency.

Parameters:

aType - The type of the Dependency.

Returns:

An instance of the DependencyBuilder class which is used to fluently configure your Dependency.

addDependency

public <T> DependencyBuilder<T> addDependency(T aInstance)

Adds a Dependency to the Reactor which's DependencyBuilder is returned for fluently configuring your Dependency.

Type Parameters:

T - The type of the Dependency.

Parameters:

aInstance - The instance of the Dependency.

Returns:

An instance of the DependencyBuilder class which is used to fluently configure your Dependency.

addDependency

public <F extends org.refcodes.factory.Factory<T>,
T>
DependencyBuilder<T> addDependency(Class<T> aType,
 F aFactory)

Adds a Dependency fabricated by a factory.

Type Parameters:

F - The type of the factory producing the Dependency.

T - The type of the Dependency itself.

Parameters:

aType - The type of the Dependency to be fabricated by the factory.

aFactory - The Factory instance producing the according Dependency declaration(s).

Returns:

An instance of the DependencyBuilder class which is used to fluently configure your Dependency.

addDependency

public <F extends org.refcodes.factory.Factory<T>,
T>
DependencyBuilder<T> addDependency(Class<T> aType,
 Class<F> aFactory)

Adds a Dependency fabricated by a factory.

Type Parameters:

F - The type of the factory producing the Dependency.

T - The type of the Dependency itself.

Parameters:

aType - The type of the Dependency to be fabricated by the factory.

aFactory - The type of the Factory producing the according Dependency declaration(s).

Returns:

An instance of the DependencyBuilder class which is used to fluently configure your Dependency.

addDependency

public <F,
T> DependencyBuilder<T> addDependency(Class<T> aType,
 Class<F> aDependency,
 Function<F,T> aFactory)

Adds a Dependency fabricated from factory's context (Dependency).

Type Parameters:

F - The type of the factory's context (Dependency).

T - The type of the Dependency itself.

Parameters:

aType - The type of the Dependency to be fabricated by the factory.

aDependency - The context (Dependency) used by the factory to produce the resulting Dependency.

aFactory - The factory Function using the context to produce the according Dependency declaration(s).

Returns:

An instance of the DependencyBuilder class which is used to fluently configure your Dependency.

hasInterceptor

public boolean hasInterceptor(DependencyInterceptor aInterceptor)

Tests whether the given DependencyInterceptor instance has been added.

Parameters:

aInterceptor - The DependencyInterceptor instance for which to test if it has been added.

Returns:

True if the given DependencyInterceptor instance has been added already.

addInterceptor

public boolean addInterceptor(DependencyInterceptor aInterceptor)

Adds the given DependencyInterceptor instance. The DependencyInterceptor instance itself acts as the handle which is used when removing the given DependencyInterceptor instance later.

Parameters:

aInterceptor - The DependencyInterceptor instance which is to be added.

Returns:

True if the DependencyInterceptor instance has been added successfully. If the DependencyInterceptor instance has already been added, false is returned.

removeInterceptor

public boolean removeInterceptor(DependencyInterceptor aInterceptor)

Removes the DependencyInterceptor instance. In case the DependencyInterceptor instance has not been added before, then false is returned.

Parameters:

aInterceptor - The DependencyInterceptor instance which is to be removed.

Returns:

True if the DependencyInterceptor instance has been removed successfully. If there was none such DependencyInterceptor instance or if the DependencyInterceptor instance has already been removed, then false is returned.

createContext

public Context createContext()
                      throws AmbigousDependencyException,
UnsatisfiedDependencyException,
CircularDependencyException,
DuplicateDependencyException,
DuplicateClaimException,
UnsatisfiedClaimException,
AmbigousClaimException,
AmbigousInitializerException,
UnsatisfiedInitializerException,
AmbigousFactoryException,
UnsatisfiedFactoryException,
InstallDependencyException

Creates a Context which describes the components and modules wired together by this Reactor.

Returns:

The accordingly wired Context instance.

Throws:

AmbigousDependencyException - thrown in case for a required Dependency there are more than one matching Dependency candidates in the Reactor.

UnsatisfiedDependencyException - thrown in case for a required Dependency none matching Dependency candidates in the Reactor have been found (taking the profiles applied into account) for the constructors of the given Dependency.

CircularDependencyException - thrown in case there is some (transitive) circular dependency between two Dependency instances.

DuplicateDependencyException - is thrown in case there are multiple identical dependencies applicable by the Reactor.

DuplicateClaimException - is thrown in case there are multiple identical claims declared by a Dependency.

UnsatisfiedClaimException - is thrown in case a Claim instance cannot be satisfied by any known Dependency instance.

AmbigousClaimException - is thrown in case one Claim can be matched by multiple dependencies.

AmbigousInitializerException - is thrown in case one InitializerClaim instance can be matched by multiple dependencies.

UnsatisfiedInitializerException - is thrown in case a InitializerClaim instance cannot be satisfied by any known Dependency declaration.

AmbigousFactoryException - is thrown in case one FactoryClaim instance can be matched by multiple dependencies.

UnsatisfiedFactoryException - is thrown in case a FactoryClaim instance cannot be satisfied by any known Dependency declaration.

InstallDependencyException - is thrown when trying to install a Dependency into the Context, though installing failed die to the dependency throwing an exception during the process of installing (e.g. instantiation).

createContext

public Context createContext(String... aProfiles)
                      throws AmbigousDependencyException,
UnsatisfiedDependencyException,
CircularDependencyException,
DuplicateDependencyException,
DuplicateClaimException,
UnsatisfiedClaimException,
AmbigousClaimException,
AmbigousInitializerException,
UnsatisfiedInitializerException,
AmbigousFactoryException,
UnsatisfiedFactoryException,
InstallDependencyException

Creates a Context, regarding the provided profiles, which describes the components and modules wired together by this Reactor.

Parameters:

aProfiles - The profiles to take into account when creating the Context instance.

Returns:

The accordingly wired Context instance, as of the provided profiles.

Throws:

AmbigousDependencyException - thrown in case for a required Dependency there are more than one matching Dependency candidates in the Reactor.

UnsatisfiedDependencyException - thrown in case for a required Dependency none matching Dependency candidates in the Reactor have been found (taking the profiles applied into account) for the constructors of the given Dependency.

CircularDependencyException - thrown in case there is some (transitive) circular dependency between two Dependency instances.

DuplicateDependencyException - is thrown in case there are multiple identical dependencies applicable by the Reactor.

DuplicateClaimException - is thrown in case there are multiple identical claims declared by a Dependency.

UnsatisfiedClaimException - is thrown in case a Claim instance cannot be satisfied by any known Dependency instance.

AmbigousClaimException - is thrown in case one Claim can be matched by multiple dependencies.

AmbigousInitializerException - is thrown in case one InitializerClaim instance can be matched by multiple dependencies.

UnsatisfiedInitializerException - is thrown in case a InitializerClaim instance cannot be satisfied by any known Dependency declaration.

AmbigousFactoryException - is thrown in case one FactoryClaim instance can be matched by multiple dependencies.

UnsatisfiedFactoryException - is thrown in case a FactoryClaim instance cannot be satisfied by any known Dependency declaration.

InstallDependencyException - is thrown when trying to install a Dependency into the Context, though installing failed die to the dependency throwing an exception during the process of installing (e.g. instantiation).

createContext

public Context createContext(Object... aProfiles)
                      throws AmbigousDependencyException,
UnsatisfiedDependencyException,
CircularDependencyException,
DuplicateDependencyException,
DuplicateClaimException,
UnsatisfiedClaimException,
AmbigousClaimException,
AmbigousInitializerException,
UnsatisfiedInitializerException,
AmbigousFactoryException,
UnsatisfiedFactoryException,
InstallDependencyException

Creates a Context, regarding the provided profiles, which describes the components and modules wired together by this Reactor.

Parameters:

aProfiles - The profiles to take into account when creating the Context instance.

Returns:

The accordingly wired Context instance, as of the provided profiles.

Throws:

AmbigousDependencyException - thrown in case for a required Dependency there are more than one matching Dependency candidates in the Reactor.

UnsatisfiedDependencyException - thrown in case for a required Dependency none matching Dependency candidates in the Reactor have been found (taking the profiles applied into account) for the constructors of the given Dependency.

CircularDependencyException - thrown in case there is some (transitive) circular dependency between two Dependency instances.

DuplicateDependencyException - is thrown in case there are multiple identical dependencies applicable by the Reactor.

DuplicateClaimException - is thrown in case there are multiple identical claims declared by a Dependency.

UnsatisfiedClaimException - is thrown in case a Claim instance cannot be satisfied by any known Dependency instance.

AmbigousClaimException - is thrown in case one Claim can be matched by multiple dependencies.

AmbigousInitializerException - is thrown in case one InitializerClaim instance can be matched by multiple dependencies.

UnsatisfiedInitializerException - is thrown in case a InitializerClaim instance cannot be satisfied by any known Dependency declaration.

AmbigousFactoryException - is thrown in case one FactoryClaim instance can be matched by multiple dependencies.

UnsatisfiedFactoryException - is thrown in case a FactoryClaim instance cannot be satisfied by any known Dependency declaration.

InstallDependencyException - is thrown when trying to install a Dependency into the Context, though installing failed die to the dependency throwing an exception during the process of installing (e.g. instantiation).

toContext

protected Context toContext(Object[] aProfiles)

Hook method to create (and prepare) an empty Context (sub-class).

Parameters:

aProfiles - The profiles being applied when creating the Context.

Returns:

The according Context (sub-class) instance.

intercept

protected <T> T intercept(T aInstance,
 Dependency<T> aDependency)

Invokes all registered DependencyInterceptor instances for the given Dependency declaration's instance for intercepting purposes.

Type Parameters:

T - The type of the Dependency.

Parameters:

aInstance - The instance created for the provided Dependency declaration.

aDependency - The Dependency declaration.

Returns:

The intercepted instance.