Package me.datafox.dfxengine.injector

Class InjectorImpl

java.lang.Object

me.datafox.dfxengine.injector.InjectorImpl

All Implemented Interfaces:

Injector

public class InjectorImpl
extends Object
implements Injector

A dependency injector. For general information, see README.md on GitHub. Use InjectorBuilder to build.

getComponent(Class), getComponent(TypeRef), getComponent(Class, Class), getComponent(TypeRef, TypeRef), getComponents(Class), getComponents(TypeRef), getComponents(Class, Class) and getComponents(TypeRef, TypeRef) can be used to retrieve components. The requesting parameter is only relevant when requesting components that have InstantiationPolicy.PER_INSTANCE.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InjectorImpl.LoggerType

Method Summary

Modifier and Type	Method	Description
<T> T	getComponent(Class<T> type)	Returns a single Component of the specified type.
<T, R> T	getComponent(Class<T> type, Class<R> requesting)	Returns a single Component of the specified type.
<T> T	getComponent(TypeRef<T> type)	Returns a single Component of the specified type.
<T, R> T	getComponent(TypeRef<T> type, TypeRef<R> requesting)	Returns a single Component of the specified type.
<T> List<T>	getComponents(Class<T> type)	Returns Components of the specified type.
<T, R> List<T>	getComponents(Class<T> type, Class<R> requesting)	Returns Components of the specified type.
<T> List<T>	getComponents(TypeRef<T> type)	Returns Components of the specified type.
<T, R> List<T>	getComponents(TypeRef<T> type, TypeRef<R> requesting)	Returns Components of the specified type.
<T> void	invokeEvent(T event)	Calls all EventHandlers with the specified event that can accept its type as a parameter.
void	invokeEvents(Collection<?> events)	Calls all EventHandlers with the specified events that can accept their types as parameters.

Methods inherited from class java.lang.Object

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

Method Details

getComponent

public <T> T getComponent(Class<T> type)

Returns a single Component of the specified type. If the Class has type parameters, use Injector.getComponent(TypeRef) instead. Otherwise, an exception is thrown. An exception is also thrown if multiple Components or no Components are present.

Specified by:

getComponent in interface Injector

Type Parameters:

T - type of the Component to be requested

Parameters:

type - type of the Component to be requested

Returns:

Component of the specified type

Throws:

ParameterCountMismatchException - if the Class has type parameters

MultipleDependenciesPresentException - if multiple Components with the specified type are present

NoDependenciesPresentException - if no Components with the specified type are present

getComponent

public <T> T getComponent(TypeRef<T> type)

Returns a single Component of the specified type. If multiple Components or no Components are present, an exception is thrown.

Specified by:

getComponent in interface Injector

Type Parameters:

T - type of the Component to be requested

Parameters:

type - type of the Component to be requested

Returns:

Component of the specified type

Throws:

MultipleDependenciesPresentException - if multiple Components with the specified type are present

NoDependenciesPresentException - if no Components with the specified type are present

getComponent

public <T,
R> T getComponent(Class<T> type,
 Class<R> requesting)

Returns a single Component of the specified type. If the Component has InstantiationPolicy.PER_INSTANCE and depends on InstantiationDetails, the requesting parameter will be used for InstantiationDetails. If the Class has type parameters, use Injector.getComponent(TypeRef) instead. An exception is also thrown if multiple Components or no Components are present.

Specified by:

getComponent in interface Injector

Type Parameters:

T - type of the Component to be requested

R - type of the object requesting the Component

Parameters:

type - type of the Component to be requested

requesting - type of the object requesting the Component

Returns:

Component of the specified type

Throws:

ParameterCountMismatchException - if the type or requesting Class has type parameters

MultipleDependenciesPresentException - if multiple Components with the specified type are present

NoDependenciesPresentException - if no Components with the specified type are present

getComponent

public <T,
R> T getComponent(TypeRef<T> type,
 TypeRef<R> requesting)

Returns a single Component of the specified type. If the Component has InstantiationPolicy.PER_INSTANCE and depends on InstantiationDetails, the requesting parameter will be used for InstantiationDetails. If multiple Components or no Components are present, an exception is thrown.

Specified by:

getComponent in interface Injector

Type Parameters:

T - type of the Component to be requested

R - type of the object requesting the Component

Parameters:

type - type of the Component to be requested

requesting - type of the object requesting the Component

Returns:

Component of the specified type

Throws:

MultipleDependenciesPresentException - if multiple Components with the specified type are present

NoDependenciesPresentException - if no Components with the specified type are present

getComponents

public <T> List<T> getComponents(Class<T> type)

Returns Components of the specified type. If the Class has type parameters, use Injector.getComponents(TypeRef) instead. Otherwise, an exception is thrown.

Specified by:

getComponents in interface Injector

Type Parameters:

T - type of the Components to be requested

Parameters:

type - type of the Components to be requested

Returns:

List of Components of the specified type

Throws:

ParameterCountMismatchException - if the Class has type parameters

getComponents

public <T> List<T> getComponents(TypeRef<T> type)

Returns Components of the specified type.

Specified by:

getComponents in interface Injector

Type Parameters:

T - type of the Components to be requested

Parameters:

type - type of the Components to be requested

Returns:

List List of Components of the specified type

getComponents

public <T,
R> List<T> getComponents(Class<T> type,
 Class<R> requesting)

Returns Components of the specified type. If any of the Components have InstantiationPolicy.PER_INSTANCE and depend on InstantiationDetails, the requesting parameter will be used for InstantiationDetails. If the Class has type parameters, use Injector.getComponent(TypeRef) instead. Otherwise, an exception is thrown.

Specified by:

getComponents in interface Injector

Type Parameters:

T - type of the Components to be requested

R - type of the object requesting the Components

Parameters:

type - type of the Components to be requested

requesting - type of the object requesting the Components

Returns:

List of Components of the specified type

Throws:

ParameterCountMismatchException - if the type or requesting Class has type parameters

getComponents

public <T,
R> List<T> getComponents(TypeRef<T> type,
 TypeRef<R> requesting)

Returns Components of the specified type. If any of the Components hav InstantiationPolicy.PER_INSTANCE and depend on InstantiationDetails, the requesting parameter will be used for InstantiationDetails.

Specified by:

getComponents in interface Injector

Type Parameters:

T - type of the Components to be requested

R - type of the object requesting the Components

Parameters:

type - type of the Components to be requested

requesting - type of the object requesting the Components

Returns:

List of Components of the specified type

invokeEvent

public <T> void invokeEvent(T event)

Calls all EventHandlers with the specified event that can accept its type as a parameter. If the event has type parameters, it must implement ParametricEvent.

Specified by:

invokeEvent in interface Injector

Type Parameters:

T - type of the event

Parameters:

event - event to be invoked

invokeEvents

public void invokeEvents(Collection<?> events)

Calls all EventHandlers with the specified events that can accept their types as parameters. If an event has type parameters, it must implement ParametricEvent.

Specified by:

invokeEvents in interface Injector

Parameters:

events - events to be invoked