com.netflix.governator

Class InjectorBuilder

java.lang.Object

com.netflix.governator.InjectorBuilder

public final class InjectorBuilder
extends java.lang.Object

Simple DSL on top of Guice through which an injector may be created using a series of operations and transformations of Guice modules. Operations are tracked using a single module and are additive such that each operation executes on top of the entire current binding state. Once all bindings have been defined the injector can be created using an InjectorCreator strategy. InjectorBuilder .fromModule(new MyApplicationModule()) .overrideWith(new OverridesForTesting()) .traceEachElement(new BindingTracingVisitor()) .createInjector();

Method Summary

Methods

Modifier and Type	Method and Description
InjectorBuilder	combineWith(com.google.inject.Module... modules) Add additional bindings to the module tracked by the DSL
LifecycleInjector	createInjector()
<I extends com.google.inject.Injector> I	createInjector(InjectorCreator<I> creator)
LifecycleInjector	createInjector(com.google.inject.Stage stage)
<I extends com.google.inject.Injector> I	createInjector(com.google.inject.Stage stage, InjectorCreator<I> creator) Create the injector in the specified stage using the specified InjectorCreator strategy.
InjectorBuilder	filter(com.google.inject.spi.ElementVisitor<java.lang.Boolean> predicate) Filter out elements for which the provided visitor returns true.
static InjectorBuilder	fromModule(com.google.inject.Module module) Start the builder using the specified module.
static InjectorBuilder	fromModules(java.util.List<com.google.inject.Module> modules)
static InjectorBuilder	fromModules(com.google.inject.Module... additionalModules)
java.util.List<com.google.inject.spi.Element>	getElements()
InjectorBuilder	map(ModuleTransformer transformer) Extend the core DSL by providing a custom ModuleTransformer.
InjectorBuilder	overrideWith(java.util.Collection<com.google.inject.Module> modules)
InjectorBuilder	overrideWith(com.google.inject.Module... modules) Override all existing bindings with bindings in the provided modules.
InjectorBuilder	stripStaticInjections() Filter out all bindings using requestStaticInjection
InjectorBuilder	traceEachElement(com.google.inject.spi.ElementVisitor<java.lang.String> visitor) Iterator through all elements of the current module and write the output of the ElementVisitor to the logger at debug level.
InjectorBuilder	traceEachKey() Log the current binding state.
InjectorBuilder	warnOfStaticInjections() Log a warning that static injection is being used.

Methods inherited from class java.lang.Object

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

Method Detail

fromModule

public static InjectorBuilder fromModule(com.google.inject.Module module)

Start the builder using the specified module.

Parameters:

module -

Returns:

fromModules

public static InjectorBuilder fromModules(com.google.inject.Module... additionalModules)

fromModules

public static InjectorBuilder fromModules(java.util.List<com.google.inject.Module> modules)

overrideWith

public InjectorBuilder overrideWith(com.google.inject.Module... modules)

Override all existing bindings with bindings in the provided modules. This method uses Guice's build in Modules.override(com.google.inject.Module...) and is preferable to using Modules.override(com.google.inject.Module...). The approach here is to attempt to promote the use of Modules.override(com.google.inject.Module...) as a single top level override. Using Modules.override(com.google.inject.Module...) inside Guice modules can result in duplicate bindings when the same module is installed in multiple placed.

Parameters:

modules -

overrideWith

public InjectorBuilder overrideWith(java.util.Collection<com.google.inject.Module> modules)

See Also:

overrideWith(Module...)

combineWith

public InjectorBuilder combineWith(com.google.inject.Module... modules)

Add additional bindings to the module tracked by the DSL

Parameters:

modules -

traceEachElement

public InjectorBuilder traceEachElement(com.google.inject.spi.ElementVisitor<java.lang.String> visitor)

Iterator through all elements of the current module and write the output of the ElementVisitor to the logger at debug level. 'null' responses are ignored

Parameters:

visitor -

traceEachKey

public InjectorBuilder traceEachKey()

Log the current binding state. traceEachKey() is useful for debugging a sequence of operation where the binding snapshot can be dumped to the log after an operation.

warnOfStaticInjections

public InjectorBuilder warnOfStaticInjections()

Log a warning that static injection is being used. Static injection is considered a 'hack' to alllow for backwards compatibility with non DI'd static code.

map

public InjectorBuilder map(ModuleTransformer transformer)

Extend the core DSL by providing a custom ModuleTransformer. The output module replaces the current module.

Parameters:

transformer -

filter

public InjectorBuilder filter(com.google.inject.spi.ElementVisitor<java.lang.Boolean> predicate)

Filter out elements for which the provided visitor returns true.

Parameters:

predicate -

stripStaticInjections

public InjectorBuilder stripStaticInjections()

Filter out all bindings using requestStaticInjection

getElements

public java.util.List<com.google.inject.spi.Element> getElements()

Returns:

Return all elements in the managed module

createInjector

public <I extends com.google.inject.Injector> I createInjector(com.google.inject.Stage stage,
                                                      InjectorCreator<I> creator)

Create the injector in the specified stage using the specified InjectorCreator strategy. The InjectorCreator will most likely perform additional error handling on top of the call to Guice.createInjector(com.google.inject.Module...).

Parameters:

stage - Stage in which the injector is running. It is recommended to run in Stage.DEVELOPEMENT since it treats all singletons as lazy as opposed to defaulting to eager instantiation which could result in instantiating unwanted classes.

creator -

createInjector

public <I extends com.google.inject.Injector> I createInjector(InjectorCreator<I> creator)

See Also:

InjectorBuilder#createInjector(Stage, InjectorCreator)}

createInjector

public LifecycleInjector createInjector(com.google.inject.Stage stage)

See Also:

InjectorBuilder#createInjector(Stage, InjectorCreator)}

createInjector

public LifecycleInjector createInjector()

See Also:

InjectorBuilder#createInjector(Stage, InjectorCreator)}