com.artemis.injection.Injector Maven / Gradle / Ivy

Go to download
package com.artemis.injection;

import com.artemis.World;

import java.util.Map;

/**
 * API used by {@link com.artemis.World} to inject objects annotated with {@link com.artemis.annotations.Wire} with
 * dependencies. An injector injects {@link com.artemis.ComponentMapper}, {@link com.artemis.BaseSystem} and {@link com.artemis
 * .Manager} types into systems and managers.
 * 
 * To inject arbitrary types, use registered through {@link com.artemis.WorldConfiguration#register}.
 * To customize the injection-strategy for arbitrary types further, registered a custom {@link com.artemis.injection.FieldHandler}
 *  with custom one or more {@link com.artemis.injection.FieldResolver}.
 *
 * @author Snorre E. Brekke
 * @see FieldHandler
 */
public interface Injector {

    /**
     * @param world this Injector will be used for
     * @param injectables registered via {@link com.artemis.WorldConfiguration#register}
     */
    void initialize(World world, Map injectables);

    /**
     * Inject dependencies on object. The injector delegates to {@link com.artemis.injection.FieldHandler} to resolve
     * feiled values.
     * @param target object which should have dependencies injected.
     * @throws RuntimeException
     * @see FieldHandler
     */
    void inject(Object target) throws RuntimeException;

    /**
     * Determins if a target object can be injected by this injector.
     * @param target eligable for injection
     * @return true if the Injector is capable of injecting the target object.
     */
    boolean isInjectable(Object target);

    /**
     * Enables the injector to be configured with a custom {@link com.artemis.injection.FieldHandler} which will
     * be used to resolve instance values for target-fields.
     * @param fieldHandler to use for resolving dependency values
     * @return this Injector for chaining
     */
    Injector setFieldHandler(FieldHandler fieldHandler);

}