Package com.seibel.distanthorizons.coreapi.DependencyInjection

Class DependencyInjector<BindableType extends IBindable>

java.lang.Object

com.seibel.distanthorizons.coreapi.DependencyInjection.DependencyInjector<BindableType>

Type Parameters:

BindableType - extends IBindable and defines what interfaces this dependency handler can deal with.

All Implemented Interfaces:

IDependencyInjector<BindableType>

Direct Known Subclasses:

ApiEventInjector

public class DependencyInjector<BindableType extends IBindable>
extends Object
implements IDependencyInjector<BindableType>

This class takes care of tracking objects used in dependency injection.

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	allowDuplicateBindings
protected final Class<? extends BindableType>	bindableInterface	Internal class reference to BindableType since we can't get it any other way.
protected final Map<Class<? extends BindableType>,ArrayList<BindableType>>	dependencies

Constructor Summary

Constructors

Constructor	Description
DependencyInjector(Class<BindableType> newBindableInterface)
DependencyInjector(Class<BindableType> newBindableInterface, boolean newAllowDuplicateBindings)

Method Summary

Modifier and Type	Method	Description
void	bind(Class<? extends BindableType> dependencyInterface, BindableType dependencyImplementation)	Links the given implementation object to an interface, so it can be referenced later.
boolean	checkIfClassExtends(Class<?> classToTest, Class<?> extensionToLookFor)	Checks if classToTest extends the given class.
boolean	checkIfClassImplements(Class<?> classToTest, Class<?> interfaceToLookFor)	Checks if classToTest (or one of its ancestors) implements the given interface.
void	clear()	Removes all bound dependencies.
<T extends BindableType> T	get(Class<T> interfaceClass)	Does not return incomplete dependencies.
<T extends BindableType> T	get(Class<T> interfaceClass, boolean allowIncompleteDependencies)	Returns a dependency of type T if one has been bound.
<T extends BindableType> ArrayList<T>	getAll(Class<T> interfaceClass)	Returns all dependencies of type T that have been bound.
void	runDelayedSetup()	Runs delayed setup for any dependencies that require it.

Methods inherited from class java.lang.Object

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

Field Details

dependencies

protected final Map<Class<? extends BindableType extends IBindable>,ArrayList<BindableType extends IBindable>> dependencies

bindableInterface

protected final Class<? extends BindableType extends IBindable> bindableInterface

Internal class reference to BindableType since we can't get it any other way.

allowDuplicateBindings

protected final boolean allowDuplicateBindings

Constructor Details

DependencyInjector

public DependencyInjector(Class<BindableType> newBindableInterface)

DependencyInjector

public DependencyInjector(Class<BindableType> newBindableInterface,
 boolean newAllowDuplicateBindings)

Method Details

bind

public void bind(Class<? extends BindableType> dependencyInterface,
 BindableType dependencyImplementation)
          throws IllegalStateException,
IllegalArgumentException

Description copied from interface: IDependencyInjector

Links the given implementation object to an interface, so it can be referenced later.

Specified by:

bind in interface IDependencyInjector<BindableType extends IBindable>

Parameters:

dependencyInterface - The interface (or parent class) the implementation object should implement.

dependencyImplementation - An object that implements the dependencyInterface interface.

Throws:

IllegalStateException - if the interface has already been bound and duplicates aren't allowed

IllegalArgumentException - if the implementation object doesn't implement the interface

checkIfClassImplements

public boolean checkIfClassImplements(Class<?> classToTest,
 Class<?> interfaceToLookFor)

Description copied from interface: IDependencyInjector

Checks if classToTest (or one of its ancestors) implements the given interface.

Specified by:

checkIfClassImplements in interface IDependencyInjector<BindableType extends IBindable>

checkIfClassExtends

public boolean checkIfClassExtends(Class<?> classToTest,
 Class<?> extensionToLookFor)

Description copied from interface: IDependencyInjector

Checks if classToTest extends the given class.

Specified by:

checkIfClassExtends in interface IDependencyInjector<BindableType extends IBindable>

get

public <T extends BindableType> T get(Class<T> interfaceClass)
                               throws ClassCastException

Description copied from interface: IDependencyInjector

Does not return incomplete dependencies.
See get(Class, boolean) for full documentation.

Specified by:

get in interface IDependencyInjector<BindableType extends IBindable>

Throws:

ClassCastException

See Also:

• IDependencyInjector.get(Class, boolean)

getAll

public <T extends BindableType> ArrayList<T> getAll(Class<T> interfaceClass)
                                             throws ClassCastException

Description copied from interface: IDependencyInjector

Returns all dependencies of type T that have been bound.
Returns an empty list if no dependencies have been bound.

Specified by:

getAll in interface IDependencyInjector<BindableType extends IBindable>

Type Parameters:

T - class of the dependency (inferred from the objectClass parameter)

Parameters:

interfaceClass - Interface of the dependency

Returns:

the dependency of type T

Throws:

ClassCastException - If the dependency isn't able to be cast to type T. (this shouldn't normally happen, unless the bound object changed somehow)

get

public <T extends BindableType> T get(Class<T> interfaceClass,
 boolean allowIncompleteDependencies)
                               throws ClassCastException

Description copied from interface: IDependencyInjector

Returns a dependency of type T if one has been bound.
Returns null if a dependency hasn't been bound.

If the handler allows duplicate bindings, this will return the first bound dependency.

Specified by:

get in interface IDependencyInjector<BindableType extends IBindable>

Type Parameters:

T - class of the dependency (inferred from the interfaceClass parameter)

Parameters:

interfaceClass - Interface of the dependency

allowIncompleteDependencies - If true this method will also return dependencies that haven't completed their delayed setup.

Returns:

the dependency of type T

Throws:

ClassCastException - If the dependency isn't able to be cast to type T. (this shouldn't normally happen, unless the bound object changed somehow)

clear

public void clear()

Removes all bound dependencies.

Specified by:

clear in interface IDependencyInjector<BindableType extends IBindable>

runDelayedSetup

public void runDelayedSetup()

Runs delayed setup for any dependencies that require it.

Specified by:

runDelayedSetup in interface IDependencyInjector<BindableType extends IBindable>