com.artemis.injection

Class CachedInjector

java.lang.Object

com.artemis.injection.CachedInjector

All Implemented Interfaces:

Injector

public final class CachedInjector
extends Object
implements Injector

By default, injects ComponentMapper, BaseSystem and Manager types into systems and managers. Can also inject arbitrary types if registered through WorldConfiguration.register(java.lang.Object). Caches all type-information.

For greater control over the dependency-resolution, provide a FieldHandler to setFieldHandler(FieldHandler), which will be used to resolve dependency values instead.

Author:

Arni Arent, Snorre E. Brekke

See Also:

FieldHandler

Constructor Summary

Constructors

Constructor and Description
CachedInjector()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedInjector

public CachedInjector()

Method Detail

setFieldHandler

public Injector setFieldHandler(FieldHandler fieldHandler)

Description copied from interface: Injector

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

Specified by:

setFieldHandler in interface Injector

Parameters:

fieldHandler - to use for resolving dependency values

Returns:

this Injector for chaining

getRegistered

public <T> T getRegistered(String id)

Description copied from interface: Injector

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

Specified by:

getRegistered in interface Injector

Parameters:

id - Name or class name.

Returns:

the requested object, or null if not found

See Also:

WorldConfiguration.register(String, Object)

getRegistered

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

Description copied from interface: Injector

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

Specified by:

getRegistered in interface Injector

Parameters:

id - Uniquely registered instance, identified by class..

Returns:

the requested object, or null if not found

See Also:

WorldConfiguration.register(Object)

initialize

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

Specified by:

initialize in interface Injector

Parameters:

world - this Injector will be used for

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

isInjectable

public boolean isInjectable(Object target)

Description copied from interface: Injector

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

Specified by:

isInjectable in interface Injector

Parameters:

target - eligable for injection

Returns:

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

inject

public void inject(Object target)
            throws RuntimeException

Description copied from interface: Injector

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

Specified by:

inject in interface Injector

Parameters:

target - object which should have dependencies injected.

Throws:

RuntimeException

See Also:

FieldHandler