Package com.seibel.distanthorizons.coreapi.interfaces.dependencyInjection

Interface IOverrideInjector<BindableType extends IBindable>

All Known Implementing Classes:

OverrideInjector

public interface IOverrideInjector<BindableType extends IBindable>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CORE_PRIORITY	All core overrides should have this priority.
static final int	DEFAULT_NON_CORE_OVERRIDE_PRIORITY	The priority given to overrides that don't explicitly define a priority.
static final int	MIN_NON_CORE_OVERRIDE_PRIORITY	The lowest priority non-core overrides can have.

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.

Field Details

CORE_PRIORITY

static final int CORE_PRIORITY

All core overrides should have this priority.
Should be lower than MIN_NON_CORE_OVERRIDE_PRIORITY.

See Also:

• Constant Field Values

MIN_NON_CORE_OVERRIDE_PRIORITY

static final int MIN_NON_CORE_OVERRIDE_PRIORITY

The lowest priority non-core overrides can have. Should be higher than CORE_PRIORITY.

See Also:

• Constant Field Values

DEFAULT_NON_CORE_OVERRIDE_PRIORITY

static final int DEFAULT_NON_CORE_OVERRIDE_PRIORITY

The priority given to overrides that don't explicitly define a priority.

See Also:

• Constant Field Values

Method Details

bind

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

See bind(Class, IBindable) for full documentation.

Throws:

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

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

See Also:

• IDependencyInjector.bind(Class, IBindable)

get

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

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

Throws:

ClassCastException

See Also:

• IDependencyInjector.get(Class, boolean)

get

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

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.

Throws:

ClassCastException

See Also:

• IDependencyInjector.get(Class, boolean)

unbind

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

Removes the given concrete IDhApiOverrideable bound to the given interface.

clear

void clear()

Removes all bound overrides.