Package me.datafox.dfxengine.injector.api

Interface Injector

All Known Implementing Classes:

InjectorImpl

public interface Injector

An interface for a dependency injector. For general information, see README.md on GitHub.

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.

Method Details

getComponent

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

Returns a single Component of the specified type. If the Class has type parameters, use getComponent(TypeRef) instead. Otherwise, an exception is thrown.

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

getComponent

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

Returns a single Component of the specified type.

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

getComponent

<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 getComponent(TypeRef) instead.

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

getComponent

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

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

getComponents

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

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

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

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

Returns Components of the specified type.

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

getComponents

<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 getComponent(TypeRef) instead. Otherwise, an exception is thrown.

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

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

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

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

Type Parameters:

T - type of the event

Parameters:

event - event to be invoked

invokeEvents

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.

Parameters:

events - events to be invoked