com.github.brokenswing.comixaire.di

Class DependencyInjector

java.lang.Object

com.github.brokenswing.comixaire.di.DependencyInjector

public class DependencyInjector
extends java.lang.Object

Class that allows manages the dependency injection in the system. This class is mainly sued to inject dependencies in JavaFX controllers through the controllers factory.

Calling inject(Object) will inject values in the fields of the given object that are annotated with the annotation passed to the constructor resolving those values from the sources added through addDependencyResolver(DependencySource).

See Also:

DependencySource

Constructor Summary

Constructors

Constructor and Description
DependencyInjector(java.lang.Class<? extends java.lang.annotation.Annotation> injectionAnnotation, boolean ignoreMissingDependencies)

Method Summary

Modifier and Type	Method and Description
void	addDependencyResolver(DependencySource source) Add a source to resolve dependencies from. When trying to resolve a dependency and that a cache-miss happens, the sources are inspected in the same order as they were added to the dependency injection system through this method.
void	disableCache() Disables cache access.
void	enableCache() Enables cache access.
void	inject(java.lang.Object injectionTarget) Injects dependencies in the given object. This fields annotated with InjectValue then tries to find a value that fits the type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyInjector

public DependencyInjector(java.lang.Class<? extends java.lang.annotation.Annotation> injectionAnnotation,
                          boolean ignoreMissingDependencies)

Method Detail

enableCache

public void enableCache()

Enables cache access.
When the cache is enabled, dependencies can be retrieved from the cache and dependencies fetched from other sources than the cache, are cached.

Cache is enabled by default.

See Also:

disableCache()

disableCache

public void disableCache()

Disables cache access.
When the cache is disabled, dependencies are not retrieved from the cache anymore and dependencies fetched from other sources than the cache are not cached.

addDependencyResolver

public void addDependencyResolver(DependencySource source)

Add a source to resolve dependencies from.
When trying to resolve a dependency and that a cache-miss happens, the sources are inspected in the same order as they were added to the dependency injection system through this method.

Parameters:

source - an instance of a class providing dependencies values

inject

public void inject(java.lang.Object injectionTarget)

Injects dependencies in the given object.
This fields annotated with InjectValue then tries to find a value that fits the type. If no value can be found be to injected, a IllegalStateException is thrown.

Parameters:

injectionTarget - the object to inject dependencies to