com.google.inject
Class InjectorBuilder

java.lang.Object
  com.google.inject.InjectorBuilder

public class InjectorBuilder
extends Object

The advanced entry point to the Guice framework. Creates Injectors from Modules, allowing many options to be configured for the Injector.

Guice supports a model of development that draws clear boundaries between APIs, Implementations of these APIs, Modules which configure these implementations, and finally Applications which consist of a collection of Modules. It is the Application, which typically defines your main() method, that bootstraps the Guice Injector using the Guice class, as in this example:

     public class FooApplication {
       public static void main(String[] args) {
         Injector injector = new InjectorBuilder().
             .stage(Stage.PRODUCTION)
             . . . 
             .addModules(
                new ModuleA(),
                new ModuleB(),
                . . .
                new FooApplicationFlagsModule(args)
             )
             .build();
         );

         // Now just bootstrap the application and you're done
         FooStarter starter = injector.getInstance(FooStarter.class);
         starter.runApplication();
       }
     }
 

Since:

3.0

Constructor Summary

InjectorBuilder()

Method Summary

InjectorBuilder	addModules(Iterable<? extends Module> modules) Adds more modules that will be used when the Injector is created.
InjectorBuilder	addModules(Module... modules) Adds more modules that will be used when the Injector is created.
Injector	build() Builds the injector.
InjectorBuilder	disableCircularProxies() Prevents Guice from constructing a Proxy when a circular dependency is found.
InjectorBuilder	requireExplicitBindings() If explicit bindings are required, then classes that are not explicitly bound in a module cannot be injected.
InjectorBuilder	stage(Stage stage) Sets the stage for the injector.

Methods inherited from class java.lang.Object

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

Constructor Detail

InjectorBuilder

public InjectorBuilder()

Method Detail

stage

public InjectorBuilder stage(Stage stage)

Sets the stage for the injector. If the stage is Stage.PRODUCTION, singletons will be eagerly loaded when the Injector is built.

requireExplicitBindings

public InjectorBuilder requireExplicitBindings()

If explicit bindings are required, then classes that are not explicitly bound in a module cannot be injected. Bindings created through a linked binding (bind(Foo.class).to(FooImpl.class)) are allowed, but the implicit binding (FooImpl) cannot be directly injected unless it is also explicitly bound. Tools can still retrieve bindings for implicit bindings (bindings created through a linked binding) if explicit bindings are required, however Binding.getProvider() cannot be used. By default, explicit bindings are not required.

disableCircularProxies

public InjectorBuilder disableCircularProxies()

Prevents Guice from constructing a Proxy when a circular dependency is found.

addModules

public InjectorBuilder addModules(Iterable<? extends Module> modules)

Adds more modules that will be used when the Injector is created.

addModules

public InjectorBuilder addModules(Module... modules)

Adds more modules that will be used when the Injector is created.

build

public Injector build()

Builds the injector.