Package com.seibel.distanthorizons.coreapi.DependencyInjection

Class OverrideInjector

java.lang.Object

com.seibel.distanthorizons.coreapi.DependencyInjection.OverrideInjector

All Implemented Interfaces:

IOverrideInjector<IDhApiOverrideable>

public class OverrideInjector
extends Object
implements IOverrideInjector<IDhApiOverrideable>

This class takes care of dependency injection for overridable objects.
This is done so other mods can override our methods to improve features down the line.

Field Summary

Fields

Modifier and Type	Field	Description
static final OverrideInjector	INSTANCE

Fields inherited from interface com.seibel.distanthorizons.coreapi.interfaces.dependencyInjection.IOverrideInjector

CORE_PRIORITY, DEFAULT_NON_CORE_OVERRIDE_PRIORITY, MIN_NON_CORE_OVERRIDE_PRIORITY

Constructor Summary

Constructors

Constructor	Description
OverrideInjector()
OverrideInjector(String newCorePackagePath)

Method Summary

Modifier and Type	Method	Description
void	bind(Class<? extends IDhApiOverrideable> dependencyInterface, IDhApiOverrideable dependencyImplementation)	See bind(Class, IBindable) for full documentation.
void	clear()	Removes all bound overrides.
<T extends IDhApiOverrideable> T	get(Class<T> interfaceClass)	Returns the bound dependency with the highest priority.
<T extends IDhApiOverrideable> T	get(Class<T> interfaceClass, int priority)	Returns a dependency of type T with the specified priority if one has been bound.
void	unbind(Class<? extends IDhApiOverrideable> dependencyInterface, IDhApiOverrideable dependencyImplementation)	Removes the given concrete IDhApiOverrideable bound to the given interface.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final OverrideInjector INSTANCE

Constructor Details

OverrideInjector

public OverrideInjector()

OverrideInjector

public OverrideInjector(String newCorePackagePath)

Method Details

bind

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

Description copied from interface: IOverrideInjector

See bind(Class, IBindable) for full documentation.

Specified by:

bind in interface IOverrideInjector<IDhApiOverrideable>

Throws:

IllegalStateException - if another override with the given priority already has been bound.

IllegalArgumentException - if a non-Distant Horizons Override with the priority IOverrideInjector.CORE_PRIORITY is passed in or an override is passed in with an invalid priority value.

See Also:

• IDependencyInjector.bind(Class, IBindable)

unbind

public void unbind(Class<? extends IDhApiOverrideable> dependencyInterface,
 IDhApiOverrideable dependencyImplementation)

Description copied from interface: IOverrideInjector

Removes the given concrete IDhApiOverrideable bound to the given interface.

Specified by:

unbind in interface IOverrideInjector<IDhApiOverrideable>

get

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

Description copied from interface: IOverrideInjector

Returns the bound dependency with the highest priority.
See get(Class, boolean) for full documentation.

Specified by:

get in interface IOverrideInjector<IDhApiOverrideable>

Throws:

ClassCastException

See Also:

• IDependencyInjector.get(Class, boolean)

get

public <T extends IDhApiOverrideable> T get(Class<T> interfaceClass,
 int priority)
                                     throws ClassCastException

Description copied from interface: IOverrideInjector

Returns a dependency of type T with the specified priority if one has been bound.
If there is a dependency, but it was bound with a different priority this will return null.

See get(Class, boolean) for more documentation.

Specified by:

get in interface IOverrideInjector<IDhApiOverrideable>

Throws:

ClassCastException

See Also:

• IDependencyInjector.get(Class, boolean)

clear

public void clear()

Description copied from interface: IOverrideInjector

Removes all bound overrides.

Specified by:

clear in interface IOverrideInjector<IDhApiOverrideable>