Package io.activej.inject.module

Class AbstractModule

java.lang.Object

io.activej.inject.module.AbstractModule

All Implemented Interfaces:

Module

public abstract class AbstractModule
extends Object
implements Module

This class is an abstract module wrapper around ModuleBuilder. It provides functionality that is similar to some other DI frameworks for the ease of transition.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractModule()

Method Summary

Modifier and Type	Method	Description
protected final <T> ModuleBuilder0<T>	bind(Key<T> key)	This method begins a chain of binding builder DSL calls
protected final <T> ModuleBuilder0<T>	bind(Class<T> type)	This method begins a chain of binding builder DSL calls.
protected final <T> ModuleBuilder0<T>	bind(Class<T> type, Object qualifier)	This method begins a chain of binding builder DSL calls.
protected final <T> void	bindInstanceInjector(Key<T> key)
protected final <T> void	bindInstanceInjector(Class<T> key)
protected final <T> void	bindInstanceProvider(Key<T> key)
protected final <T> void	bindInstanceProvider(Class<T> key)
protected final <S, T extends S> void	bindIntoSet(Key<S> setOf, Binding<T> binding)	This is a helper method that provides a functionality similar to ProvidesIntoSet.
protected final <S, T extends S> void	bindIntoSet(Key<S> setOf, Key<T> item)	This is a helper method that provides a functionality similar to ProvidesIntoSet.
protected final <S, T extends S> void	bindIntoSet(Key<S> setOf, T element)	This is a helper method that provides a functionality similar to ProvidesIntoSet.
protected final <T> void	bindOptionalDependency(Key<T> key)
protected final <T> void	bindOptionalDependency(Class<T> key)
Module	combineWith(Module another)
protected void	configure()	This method is meant to be overridden to call all the bind(...) methods.
protected final <T> void	generate(KeyPattern<T> pattern, BindingGenerator<T> bindingGenerator)	Adds a generator for a given class to this module.
protected final <T> void	generate(Class<T> pattern, BindingGenerator<T> bindingGenerator)
final Map<KeyPattern<?>,Set<BindingGenerator<?>>>	getBindingGenerators()
final Trie<Scope,Map<Key<?>,Set<Binding<?>>>>	getBindings()
final Map<KeyPattern<?>,Set<BindingTransformer<?>>>	getBindingTransformers()
final Map<Key<?>,Multibinder<?>>	getMultibinders()
protected final void	install(Module module)	Adds all bindings, transformers, generators and multibinders from given modules to this one.
protected final <T> void	multibind(Key<T> key, Multibinder<T> multibinder)	Adds a multibinder for a given key to this module.
protected final <K, V> void	multibindToMap(Class<K> keyType, Class<V> valueType)
protected final <K, V> void	multibindToMap(Class<K> keyType, Class<V> valueType, Object qualifier)
protected final <V> void	multibindToSet(Key<V> key)
protected final <V> void	multibindToSet(Class<V> type)
protected final <V> void	multibindToSet(Class<V> type, Object qualifier)
Module	overrideWith(Module another)
protected final void	scan(Class<?> cls)
protected final void	scan(Object object)
String	toString()
protected final <T> void	transform(KeyPattern<T> pattern, BindingTransformer<T> bindingTransformer)	Adds a transformer with a given type to this module.
protected final <T> void	transform(Class<T> pattern, BindingTransformer<T> bindingTransformer)
Module	transformWith(UnaryOperator<Module> fn)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.activej.inject.module.Module

getExports, getImports

Constructor Details

AbstractModule

protected AbstractModule()

Method Details

configure

protected void configure()

This method is meant to be overridden to call all the bind(...) methods.

bind

protected final <T> ModuleBuilder0<T> bind(Key<T> key)

This method begins a chain of binding builder DSL calls

See Also:

• ModuleBuilder.bind(Key)

bind

protected final <T> ModuleBuilder0<T> bind(Class<T> type)

This method begins a chain of binding builder DSL calls.

See Also:

• ModuleBuilder.bind(Key)

bind

protected final <T> ModuleBuilder0<T> bind(Class<T> type,
 Object qualifier)

This method begins a chain of binding builder DSL calls.

See Also:

• ModuleBuilder.bind(Key)

bindInstanceProvider

protected final <T> void bindInstanceProvider(Class<T> key)

bindInstanceProvider

protected final <T> void bindInstanceProvider(Key<T> key)

bindInstanceInjector

protected final <T> void bindInstanceInjector(Class<T> key)

bindInstanceInjector

protected final <T> void bindInstanceInjector(Key<T> key)

bindOptionalDependency

protected final <T> void bindOptionalDependency(Class<T> key)

bindOptionalDependency

protected final <T> void bindOptionalDependency(Key<T> key)

install

protected final void install(Module module)

Adds all bindings, transformers, generators and multibinders from given modules to this one.

This works just as if you'd define all of those directly in this module.

See Also:

• ModuleBuilder.install(java.util.Collection<io.activej.inject.module.Module>)

generate

protected final <T> void generate(KeyPattern<T> pattern,
 BindingGenerator<T> bindingGenerator)

Adds a generator for a given class to this module.

See Also:

• ModuleBuilder.generate(io.activej.inject.KeyPattern<T>, io.activej.inject.binding.BindingGenerator<T>)

generate

protected final <T> void generate(Class<T> pattern,
 BindingGenerator<T> bindingGenerator)

transform

protected final <T> void transform(KeyPattern<T> pattern,
 BindingTransformer<T> bindingTransformer)

Adds a transformer with a given type to this module.

See Also:

• ModuleBuilder.transform(io.activej.inject.KeyPattern<T>, io.activej.inject.binding.BindingTransformer<T>)

transform

protected final <T> void transform(Class<T> pattern,
 BindingTransformer<T> bindingTransformer)

multibind

protected final <T> void multibind(Key<T> key,
 Multibinder<T> multibinder)

Adds a multibinder for a given key to this module.

See Also:

• ModuleBuilder.multibind(io.activej.inject.Key<T>, io.activej.inject.binding.Multibinder<T>)

multibindToSet

protected final <V> void multibindToSet(Class<V> type)

multibindToSet

protected final <V> void multibindToSet(Class<V> type,
 Object qualifier)

multibindToSet

protected final <V> void multibindToSet(Key<V> key)

multibindToMap

protected final <K,
V> void multibindToMap(Class<K> keyType,
 Class<V> valueType)

multibindToMap

protected final <K,
V> void multibindToMap(Class<K> keyType,
 Class<V> valueType,
 Object qualifier)

bindIntoSet

protected final <S,
T extends S> void bindIntoSet(Key<S> setOf,
 Binding<T> binding)

This is a helper method that provides a functionality similar to ProvidesIntoSet. It binds given binding as a singleton set to a set key made from given key and also multibinds each of such sets together.

See Also:

• ModuleBuilder.bindIntoSet(Key, Binding)

bindIntoSet

protected final <S,
T extends S> void bindIntoSet(Key<S> setOf,
 Key<T> item)

This is a helper method that provides a functionality similar to ProvidesIntoSet. It binds given binding as a singleton set to a set key made from given key and also multibinds each of such sets together.

See Also:

• ModuleBuilder.bindIntoSet(Key, Binding)

bindIntoSet

protected final <S,
T extends S> void bindIntoSet(Key<S> setOf,
 T element)

This is a helper method that provides a functionality similar to ProvidesIntoSet. It binds given binding as a singleton set to a set key made from given key and also multibinds each of such sets together.

See Also:

• ModuleBuilder.bindIntoSet(Key, Binding)

scan

protected final void scan(Object object)

scan

protected final void scan(Class<?> cls)

getBindings

public final Trie<Scope,Map<Key<?>,Set<Binding<?>>>> getBindings()

Specified by:

getBindings in interface Module

getBindingTransformers

public final Map<KeyPattern<?>,Set<BindingTransformer<?>>> getBindingTransformers()

Specified by:

getBindingTransformers in interface Module

getBindingGenerators

public final Map<KeyPattern<?>,Set<BindingGenerator<?>>> getBindingGenerators()

Specified by:

getBindingGenerators in interface Module

getMultibinders

public final Map<Key<?>,Multibinder<?>> getMultibinders()

Specified by:

getMultibinders in interface Module

combineWith

public Module combineWith(Module another)

Specified by:

combineWith in interface Module

overrideWith

public Module overrideWith(Module another)

Specified by:

overrideWith in interface Module

transformWith

public Module transformWith(UnaryOperator<Module> fn)

Specified by:

transformWith in interface Module

toString

public String toString()

Overrides:

toString in class Object