Module org.refcodes.decoupling

Package org.refcodes.decoupling

Class DependencyImpl<T>

java.lang.Object

org.refcodes.decoupling.DependencyImpl<T>

Type Parameters:

T - the generic type of the Dependency.

All Implemented Interfaces:

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

Direct Known Subclasses:

DependencyBuilderImpl

public class DependencyImpl<T>
extends Object
implements Dependency<T>

An implementation of a Dependency.

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 Factory<?,T>	_factory
protected InstanceMetrics	_instanceMetrics
protected Set<T>	_instances
protected Set<Object>	_profiles
protected Setup<?,T>	_setup
protected T	_singleton
protected Set<Object>	_tags
protected Class<T>	_type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAlias()
Claim[]	getClaims()	Retrieves the Claim instances from the Claim instances property.
Factory<?,T>	getFactory()	Retrieves the Factory, 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 instance.
Setup<?,T>	getSetup()	Retrieves the Setup, being a Claim dedicated to initialize the dependency after instantiation.
Object[]	getTags()	Retrieves the tags assigned to the Dependency instance.
Class<T>	getType()
int	hashCode()
boolean	hasInstance()	Determines weather this Dependency element has at least one instance of its type TypeAccessor.getType() being created.
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 instances (the Dependency instances are prepared by the Reactor's Reactor.createContext() and the like methods and in turn by the toInstance(Dependency[], Set) method).
protected T	toInstance(Dependency<?>[] aDependencies)	Creates the Dependency's instance as of its type using the provided Dependency instances.
protected T	toInstance(Dependency<?>[] aDependencies, Set<Dependency<?>> aVistedDependencies)	Creates the Dependency's instance as of its type using the provided Dependency instances.
protected T	toPostProcessed(T aInstance)	Hook method to be overwritten by sub-classes in order to decorate new aspects to the produced instance.
DependencySchema	toSchema()	Retrieves the DependencySchema representing this Dependency.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.decoupling.Dependency

compareTo, hasInstance

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

_setup

protected Setup<?,T> _setup

_factory

protected Factory<?,T> _factory

Constructor Details

DependencyImpl

protected DependencyImpl()

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 Setup<?,T> getSetup()

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

Specified by:

getSetup in interface Dependency<T>

Returns:

The Setup being set for this Dependency.

getFactory

public Factory<?,T> getFactory()

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

Specified by:

getFactory in interface Dependency<T>

Returns:

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

Specified by:

getInstances in interface Dependency<T>

Returns:

The instances fabricated by this Dependency instance.

getProfiles

public Object[] getProfiles()

Retrieves the profiles assigned to the Dependency instance.

Specified by:

getProfiles in interface ProfilesAccessor

Returns:

The assigned profiles.

getTags

public Object[] getTags()

Retrieves the tags assigned to the Dependency instance.

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

hasInstance

public boolean hasInstance()

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

Specified by:

hasInstance in interface Dependency<T>

Returns:

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

toInstance

public T toInstance()
             throws DependencyInstanciationException

Creates the Dependency's instance using the prepared Dependency instances (the Dependency instances are prepared by the Reactor's Reactor.createContext() and the like methods and in turn by the toInstance(Dependency[], Set) method).

Specified by:

toInstance in interface Dependency<T>

Returns:

The instance retrieved from the Dependency.

Throws:

DependencyInstanciationException - the dependency instantiation exception

toSchema

public DependencySchema toSchema()

Retrieves the DependencySchema representing this Dependency. Retrieving a DependencySchema is useful when analyzing and debugging the dependency hierarchy if a Dependency.

Specified by:

toSchema in interface Dependency<T>

Specified by:

toSchema in interface org.refcodes.mixin.Schemable

Returns:

The DependencySchema representation of the implementing type for debugging and verification (or documentation) purposes.

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)
                throws CircularDependencyException,
AmbigousDependencyException,
UnsatisfiedDependencyException,
AmbigousClaimException,
AmbigousSetupException,
AmbigousFactoryException,
InstallDependencyException

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

Parameters:

aDependencies - the Dependency instances to use.

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.

AmbigousSetupException - is thrown in case one Setup instance can be matched by multiple dependencies.

AmbigousFactoryException - is thrown in case one Factory 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)
                throws CircularDependencyException,
AmbigousDependencyException,
UnsatisfiedDependencyException,
AmbigousClaimException,
AmbigousSetupException,
AmbigousFactoryException,
InstallDependencyException

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

Parameters:

aDependencies - the Dependency instances to use.

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

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.

AmbigousSetupException - is thrown in case one Setup instance can be matched by multiple dependencies.

AmbigousFactoryException - is thrown in case one Factory 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).

toPostProcessed

protected T toPostProcessed(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.