com.artemis.injection

Interface Injector

All Known Implementing Classes:

CachedInjector

public interface Injector

API used by World to inject objects annotated with Wire with dependencies. An injector injects ComponentMapper, BaseSystem and .Manager types into systems and managers.

To inject arbitrary types, use registered through WorldConfiguration.register(java.lang.Object).

To customize the injection-strategy for arbitrary types further, registered a custom FieldHandler with custom one or more FieldResolver.

Author:

Snorre E. Brekke

See Also:

FieldHandler

Method Summary

Modifier and Type	Method and Description
<T> T	getRegistered(Class<T> id) Programmatic retrieval of registered objects.
<T> T	getRegistered(String id) Programmatic retrieval of registered objects.
void	initialize(World world, Map<String,Object> injectables)
void	inject(Object target) Inject dependencies on object.
boolean	isInjectable(Object target) Determins if a target object can be injected by this injector.
Injector	setFieldHandler(FieldHandler fieldHandler) Enables the injector to be configured with a custom FieldHandler which will be used to resolve instance values for target-fields.

Method Detail

getRegistered

<T> T getRegistered(String id)

Programmatic retrieval of registered objects. Useful when full injection isn't necessary.

Parameters:

id - Name or class name.

Returns:

the requested object, or null if not found

See Also:

WorldConfiguration.register(String, Object)

getRegistered

<T> T getRegistered(Class<T> id)

Programmatic retrieval of registered objects. Useful when full injection isn't necessary. This method internally calls getRegistered(String), with the class name as parameter.

Parameters:

id - Uniquely registered instance, identified by class..

Returns:

the requested object, or null if not found

See Also:

WorldConfiguration.register(Object)

initialize

void initialize(World world,
                Map<String,Object> injectables)

Parameters:

world - this Injector will be used for

injectables - registered via WorldConfiguration.register(java.lang.Object)

Throws:

InjectionException - when injector lacks a means to inject injectables.

inject

void inject(Object target)
     throws RuntimeException

Inject dependencies on object. The injector delegates to FieldHandler to resolve feiled values.

Parameters:

target - object which should have dependencies injected.

Throws:

RuntimeException

See Also:

FieldHandler

isInjectable

boolean isInjectable(Object target)

Determins if a target object can be injected by this injector.

Parameters:

target - eligable for injection

Returns:

true if the Injector is capable of injecting the target object.

setFieldHandler

Injector setFieldHandler(FieldHandler fieldHandler)

Enables the injector to be configured with a custom FieldHandler which will be used to resolve instance values for target-fields.

Parameters:

fieldHandler - to use for resolving dependency values

Returns:

this Injector for chaining