Package io.activej.inject.module

Interface ModuleBuilder

All Known Subinterfaces:

ModuleBuilder0<T>, ModuleBuilder1<T>

All Known Implementing Classes:

ModuleBuilderImpl

public interface ModuleBuilder

This interface is used to restrict the DSL. Basically, it disallows any methods from ModuleBuilder0 not listed below to be called without previously calling bind(...).

Method Summary

Modifier and Type	Method	Description
<T> ModuleBuilder0<T>	bind(Key<T> key)	This method begins a chain of binding builder DSL calls.
default <T> ModuleBuilder0<T>	bind(Class<T> cls)	Begins a chain of binding builder DSL calls
default <T> ModuleBuilder0<T>	bind(Class<T> cls, Object qualifier)	Begins a chain of binding builder DSL calls
default <T> ModuleBuilder	bindInstanceInjector(Key<T> key)
default <T> ModuleBuilder	bindInstanceInjector(Class<T> type)
default <T> ModuleBuilder	bindInstanceProvider(Key<T> key)
default <T> ModuleBuilder	bindInstanceProvider(Class<T> type)
<S, T extends S> ModuleBuilder	bindIntoSet(Key<S> setOf, Binding<T> binding)	This is a helper method that provides a functionality similar to ProvidesIntoSet.
default <S, T extends S> ModuleBuilder	bindIntoSet(Key<S> setOf, Key<T> item)	A helper method that provides a functionality similar to ProvidesIntoSet.
default <T> ModuleBuilder	bindOptionalDependency(Key<T> key)
default <T> ModuleBuilder	bindOptionalDependency(Class<T> type)
Module	build()
static ModuleBuilder	create()
<T> ModuleBuilder	generate(KeyPattern<T> pattern, BindingGenerator<T> bindingGenerator)	Adds a generator for a given class to this module.
default <T> ModuleBuilder	generate(Class<T> pattern, BindingGenerator<T> bindingGenerator)	Adds a generator for a given class to this module.
default ModuleBuilder	install(Module... modules)	Adds all bindings, transformers, generators and multibinders from given modules to this one.
ModuleBuilder	install(Collection<Module> modules)	Adds all bindings, transformers, generators and multibinders from given modules to this one.
<T> ModuleBuilder	multibind(Key<T> key, Multibinder<T> multibinder)	Adds a multibinder for a given key to this module.
default <K, V> ModuleBuilder	multibindToMap(Class<K> keyType, Class<V> valueType)
default <K, V> ModuleBuilder	multibindToMap(Class<K> keyType, Class<V> valueType, Object qualifier)
default <V> ModuleBuilder	multibindToSet(Key<V> key)
default <V> ModuleBuilder	multibindToSet(Class<V> type)
default <V> ModuleBuilder	multibindToSet(Class<V> type, Object qualifier)
default ModuleBuilder	scan(Class<?> container)	Same as scan(java.lang.Class<?>, java.lang.Object), but scans only static methods and does not depend on instance of the class.
ModuleBuilder	scan(Class<?> containerClass, @Nullable Object container)	Scans class hierarchy and then installs providers from each class as modules, so that exports do not interfere between classes.
default ModuleBuilder	scan(Object container)	Same as scan(java.lang.Class<?>, java.lang.Object), with staring class defaulting to the class of the object instance.
<T> ModuleBuilder	transform(KeyPattern<T> pattern, BindingTransformer<T> bindingTransformer)	Adds a transformer with a given type to this module.
default <T> ModuleBuilder	transform(Class<T> pattern, BindingTransformer<T> bindingTransformer)	Adds a transformer with a given class to this module.

Method Details

create

static ModuleBuilder create()

install

ModuleBuilder install(Collection<Module> modules)

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.

install

default ModuleBuilder install(Module... modules)

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:

• install(Collection)

scan

ModuleBuilder scan(Class<?> containerClass,
 @Nullable
 @Nullable Object container)

Scans class hierarchy and then installs providers from each class as modules, so that exports do not interfere between classes. Class parameter is used to specify from which class in the hierarchy to start.

scan

default ModuleBuilder scan(Object container)

Same as scan(java.lang.Class<?>, java.lang.Object), with staring class defaulting to the class of the object instance.

scan

default ModuleBuilder scan(Class<?> container)

Same as scan(java.lang.Class<?>, java.lang.Object), but scans only static methods and does not depend on instance of the class. Non-static annotated methods are prohibited.

bind

default <T> ModuleBuilder0<T> bind(Class<T> cls)

Begins a chain of binding builder DSL calls

See Also:

• bind(Key)

bind

default <T> ModuleBuilder0<T> bind(Class<T> cls,
 Object qualifier)

Begins a chain of binding builder DSL calls

See Also:

• bind(Key)

bind

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

This method begins a chain of binding builder DSL calls.

You can use generics in it, only those that are defined at the module class. And you need to subclass the module at the usage point to 'bake' those generics into subclass bytecode so that they could be fetched by this bind call.

bindInstanceProvider

default <T> ModuleBuilder bindInstanceProvider(Class<T> type)

bindInstanceProvider

default <T> ModuleBuilder bindInstanceProvider(Key<T> key)

bindInstanceInjector

default <T> ModuleBuilder bindInstanceInjector(Class<T> type)

bindInstanceInjector

default <T> ModuleBuilder bindInstanceInjector(Key<T> key)

bindOptionalDependency

default <T> ModuleBuilder bindOptionalDependency(Class<T> type)

bindOptionalDependency

default <T> ModuleBuilder bindOptionalDependency(Key<T> key)

bindIntoSet

<S,
T extends S> ModuleBuilder 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.

bindIntoSet

default <S,
T extends S> ModuleBuilder bindIntoSet(Key<S> setOf,
 Key<T> item)

A helper method that provides a functionality similar to ProvidesIntoSet.

See Also:

• bindIntoSet(Key, Binding)
• Binding.to(Key)

generate

<T> ModuleBuilder generate(KeyPattern<T> pattern,
 BindingGenerator<T> bindingGenerator)

Adds a generator for a given class to this module.

generate

default <T> ModuleBuilder generate(Class<T> pattern,
 BindingGenerator<T> bindingGenerator)

Adds a generator for a given class to this module.

transform

<T> ModuleBuilder transform(KeyPattern<T> pattern,
 BindingTransformer<T> bindingTransformer)

Adds a transformer with a given type to this module.

transform

default <T> ModuleBuilder transform(Class<T> pattern,
 BindingTransformer<T> bindingTransformer)

Adds a transformer with a given class to this module.

multibind

<T> ModuleBuilder multibind(Key<T> key,
 Multibinder<T> multibinder)

Adds a multibinder for a given key to this module.

multibindToSet

default <V> ModuleBuilder multibindToSet(Class<V> type)

multibindToSet

default <V> ModuleBuilder multibindToSet(Class<V> type,
 Object qualifier)

multibindToSet

default <V> ModuleBuilder multibindToSet(Key<V> key)

multibindToMap

default <K,
V> ModuleBuilder multibindToMap(Class<K> keyType,
 Class<V> valueType)

multibindToMap

default <K,
V> ModuleBuilder multibindToMap(Class<K> keyType,
 Class<V> valueType,
 Object qualifier)

build

Module build()