Module org.refcodes.decoupling

Package org.refcodes.decoupling

Class Dependency<T>

java.lang.Object

org.refcodes.decoupling.Dependency<T>

Type Parameters:

T - the generic type of the Dependency.

All Implemented Interfaces:

Comparable<Dependency<T>>, ClaimsAccessor, InstanceMetricsAccessor, ProfilesAccessor, TagsAccessor, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.TypeAccessor<T>, org.refcodes.schema.Schemable

Direct Known Subclasses:

DependencyBuilder

public class Dependency<T>
extends Object
implements org.refcodes.schema.Schemable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.TypeAccessor<T>, ProfilesAccessor, TagsAccessor, InstanceMetricsAccessor, ClaimsAccessor, Comparable<Dependency<T>>

A Dependency describes a component wired together by the Reactor with other components also defined by Dependency instances.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.decoupling.ClaimsAccessor

ClaimsAccessor.ClaimsBuilder<B extends ClaimsAccessor.ClaimsBuilder<B>>, ClaimsAccessor.ClaimsMutator, ClaimsAccessor.ClaimsProperty

Nested classes/interfaces inherited from interface org.refcodes.decoupling.InstanceMetricsAccessor

InstanceMetricsAccessor.InstanceMetricsBuilder<B extends InstanceMetricsAccessor.InstanceMetricsBuilder<B>>, InstanceMetricsAccessor.InstanceMetricsMutator, InstanceMetricsAccessor.InstanceMetricsProperty

Nested classes/interfaces inherited from interface org.refcodes.decoupling.ProfilesAccessor

ProfilesAccessor.ProfilesBuilder<B extends ProfilesAccessor.ProfilesBuilder<B>>, ProfilesAccessor.ProfilesMutator, ProfilesAccessor.ProfilesProperty

Nested classes/interfaces inherited from interface org.refcodes.decoupling.TagsAccessor

TagsAccessor.TagsBuilder<B extends TagsAccessor.TagsBuilder<B>>, TagsAccessor.TagsMutator, TagsAccessor.TagsProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_alias
protected Set<Claim>	_claims
protected Dependency<?>[]	_dependencies
protected FactoryClaim<?,T>	_factory
protected InitializerClaim<?,T>	_initializer
protected InstanceMetrics	_instanceMetrics
protected Set<T>	_instances
protected Set<Object>	_profiles
protected Reactor	_reactor
protected T	_singleton
protected Set<Object>	_tags
protected Class<T>	_type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Dependency()	Instantiates a new Dependency.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Dependency<T> aDependency)
boolean	equals(Object obj)
String	getAlias()
Claim[]	getClaims()	Retrieves the Claim instances from the Claim instances property.
FactoryClaim<?,T>	getFactory()	Retrieves the FactoryClaim, being a Claim dedicated to fabricate (create) the dependency.
InstanceMetrics	getInstanceMetrics()	Retrieves the InstanceMetrics which describes how an instance for a Dependency is managed.
T[]	getInstances()	Retrieves the instances produced by this Dependency (as of the Dependency's InstanceMetrics configuration).
Object[]	getProfiles()	Retrieves the profiles assigned to the Dependency declaration.
InitializerClaim<?,T>	getSetup()	Retrieves the InitializerClaim, being a Claim dedicated to initialize the dependency after instantiation.
Object[]	getTags()	Retrieves the tags assigned to the Dependency declaration.
Class<T>	getType()
int	hashCode()
boolean	hasInstance(Object aInstance)	Determines whether this Dependency element contains the provided instance.
boolean	hasInstances()	Determines weather this Dependency element has at least one instance of its type getType() being created.
boolean	hasProfile(Object... aProfiles)	Tests whether this Dependency matches any of the provided profiles.
protected T	intercept(T aInstance)	Hook method to be overwritten by sub-classes in order to decorate new aspects to the produced instance.
protected void	setInstance(T aInstance)	Sets the instance for the Dependency (the type is derived from the instance if not already set, the alias is derived from type if not already set).
T	toInstance()	Creates the Dependency's instance using the prepared Dependency declarations (the Dependency declarations are prepared by the Reactor's Reactor.createContext() and the like methods and in turn by the underlying toInstance() methods).
protected T	toInstance(Dependency<?>[] aDependencies, Object... aProfiles)	Creates the Dependency's instance as of its type using the provided Dependency declarations.
protected T	toInstance(Dependency<?>[] aDependencies, Set<Dependency<?>> aVistedDependencies, Object... aProfiles)	Creates the Dependency's instance as of its type using the provided Dependency declarations.
DependencySchema	toSchema()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

_singleton

protected T _singleton

_alias

protected String _alias

_claims

protected Set<Claim> _claims

_dependencies

protected Dependency<?>[] _dependencies

_instanceMetrics

protected InstanceMetrics _instanceMetrics

_instances

protected Set<T> _instances

_profiles

protected Set<Object> _profiles

_tags

protected Set<Object> _tags

_type

protected Class<T> _type

_initializer

protected InitializerClaim<?,T> _initializer

_factory

protected FactoryClaim<?,T> _factory

_reactor

protected Reactor _reactor

Constructor Details

Dependency

protected Dependency()

Instantiates a new Dependency.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

getClaims

public Claim[] getClaims()

Retrieves the Claim instances from the Claim instances property.

Specified by:

getClaims in interface ClaimsAccessor

Returns:

The Claim instances stored by the Claim instances property.

getSetup

public InitializerClaim<?,T> getSetup()

Retrieves the InitializerClaim, being a Claim dedicated to initialize the dependency after instantiation.

Returns:

The InitializerClaim being set for this Dependency.

getFactory

public FactoryClaim<?,T> getFactory()

Retrieves the FactoryClaim, being a Claim dedicated to fabricate (create) the dependency.

Returns:

The FactoryClaim being set for this Dependency.

getInstanceMetrics

public InstanceMetrics getInstanceMetrics()

Retrieves the InstanceMetrics which describes how an instance for a Dependency is managed.

Specified by:

getInstanceMetrics in interface InstanceMetricsAccessor

Returns:

The according InstanceMetrics.

getInstances

public T[] getInstances()

Retrieves the instances produced by this Dependency (as of the Dependency's InstanceMetrics configuration).

Returns:

The instances fabricated by this Dependency declaration.

getProfiles

public Object[] getProfiles()

Retrieves the profiles assigned to the Dependency declaration.

Specified by:

getProfiles in interface ProfilesAccessor

Returns:

The assigned profiles.

getTags

public Object[] getTags()

Retrieves the tags assigned to the Dependency declaration.

Specified by:

getTags in interface TagsAccessor

Returns:

The assigned tags.

getType

public Class<T> getType()

Specified by:

getType in interface org.refcodes.mixin.TypeAccessor<T>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasInstances

public boolean hasInstances()

Determines weather this Dependency element has at least one instance of its type getType() being created.

Returns:

True in case instances for this Dependency have already been created.

hasInstance

public boolean hasInstance(Object aInstance)

Determines whether this Dependency element contains the provided instance.

Parameters:

aInstance - The instance which is to be tested.

Returns:

True in case this Dependency element contains the given instance, else false.

hasProfile

public boolean hasProfile(Object... aProfiles)

Tests whether this Dependency matches any of the provided profiles.

Parameters:

aProfiles - The profiles (as provided by the Reactor) to match against.

Returns:

True in case this Dependency matches at least one of the provided profiles.

toInstance

public T toInstance()
             throws DependencyInstanciationException

Creates the Dependency's instance using the prepared Dependency declarations (the Dependency declarations are prepared by the Reactor's Reactor.createContext() and the like methods and in turn by the underlying toInstance() methods).

Returns:

The instance retrieved from the Dependency.

Throws:

DependencyInstanciationException - the dependency instantiation exception

toSchema

public DependencySchema toSchema()

Specified by:

toSchema in interface org.refcodes.schema.Schemable

compareTo

public int compareTo(Dependency<T> aDependency)

Specified by:

compareTo in interface Comparable<T>

toString

public String toString()

Overrides:

toString in class Object

setInstance

protected void setInstance(T aInstance)

Sets the instance for the Dependency (the type is derived from the instance if not already set, the alias is derived from type if not already set).

Parameters:

aInstance - The instance of the dependency;

toInstance

protected T toInstance(Dependency<?>[] aDependencies,
 Object... aProfiles)
                throws CircularDependencyException,
AmbigousDependencyException,
UnsatisfiedDependencyException,
AmbigousClaimException,
AmbigousInitializerException,
AmbigousFactoryException,
InstallDependencyException

Creates the Dependency's instance as of its type using the provided Dependency declarations.

Parameters:

aDependencies - the Dependency declarations to use.

aProfiles - The profiles as provided by the Reactor to take into account.

Returns:

The instance retrieved from the Dependency.

Throws:

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

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.

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.

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

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).

toInstance

protected T toInstance(Dependency<?>[] aDependencies,
 Set<Dependency<?>> aVistedDependencies,
 Object... aProfiles)
                throws CircularDependencyException,
AmbigousDependencyException,
UnsatisfiedDependencyException,
AmbigousClaimException,
AmbigousInitializerException,
AmbigousFactoryException,
InstallDependencyException

Creates the Dependency's instance as of its type using the provided Dependency declarations.

Parameters:

aDependencies - the Dependency declarations to use.

aVistedDependencies - The Dependency declarations already visited in order to detect a circular dependency situation.

aProfiles - The profiles as provided by the Reactor to take into account.

Returns:

The instance retrieved from the Dependency.

Throws:

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

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.

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.

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

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).

intercept

protected T intercept(T aInstance)

Hook method to be overwritten by sub-classes in order to decorate new aspects to the produced instance.

Parameters:

aInstance - The instance to be post processed.

Returns:

The (new) post processed instance.