com.netflix.governator.guice

Interface LifecycleInjectorBuilder

All Known Implementing Classes:

DelegatingLifecycleInjectorBuilder

public interface LifecycleInjectorBuilder

Builder for a LifecycleInjector

Method Summary

Methods

Modifier and Type	Method and Description
LifecycleInjector	build() Build and return the injector
com.google.inject.Injector	createInjector() Deprecated. this API creates the "main" child injector. but it has the side effect of calling build() method that will create a new LifecycleInjector. Instead, you should just build() LifecycleInjector object. then call LifecycleInjector.createInjector() directly.
LifecycleInjectorBuilder	ignoringAllAutoBindClasses() Do not bind ANY AutoBindSingleton classes
LifecycleInjectorBuilder	ignoringAutoBindClasses(java.util.Collection<java.lang.Class<?>> ignoreClasses) Specify specific AutoBindSingleton classes that should NOT be bound in the main binding phase
LifecycleInjectorBuilder	inStage(com.google.inject.Stage stage) Set the Guice stage - the default is Production
LifecycleInjectorBuilder	usingBasePackages(java.util.Collection<java.lang.String> basePackages) Specify the base packages for CLASSPATH scanning.
LifecycleInjectorBuilder	usingBasePackages(java.lang.String... basePackages) Specify the base packages for CLASSPATH scanning.
LifecycleInjectorBuilder	usingClasspathScanner(ClasspathScanner scanner) Normally, the classpath scanner is allocated internally.
LifecycleInjectorBuilder	withAdditionalBootstrapModules(BootstrapModule... modules) Specify additional bootstrap modules to use
LifecycleInjectorBuilder	withAdditionalBootstrapModules(java.lang.Iterable<? extends BootstrapModule> modules) Specify additional bootstrap modules to use
LifecycleInjectorBuilder	withAdditionalModuleClasses(java.lang.Class<?>... modules) Specify a set of module classes from which a set of additional modules may be derived using module dependencies.
LifecycleInjectorBuilder	withAdditionalModuleClasses(java.lang.Iterable<java.lang.Class<? extends com.google.inject.Module>> modules) Specify a set of module classes from which a set of additional modules may be derived using module dependencies.
LifecycleInjectorBuilder	withAdditionalModules(java.lang.Iterable<? extends com.google.inject.Module> modules) Add to any modules already specified via withModules(Iterable)
LifecycleInjectorBuilder	withAdditionalModules(com.google.inject.Module... modules) Add to any modules already specified via withModules(Iterable)
LifecycleInjectorBuilder	withBootstrapModule(BootstrapModule module) Specify a bootstrap module
LifecycleInjectorBuilder	withMode(LifecycleInjectorMode mode) Set the lifecycle injector mode - default is LifecycleInjectorMode.REAL_CHILD_INJECTORS
LifecycleInjectorBuilder	withModuleClass(java.lang.Class<? extends com.google.inject.Module> module) Specify a module class from which a set of additional modules may be derived using module dependencies.
LifecycleInjectorBuilder	withModuleClasses(java.lang.Class<?>... modules) Specify a set of module classes from which a set of additional modules may be derived using module dependencies.
LifecycleInjectorBuilder	withModuleClasses(java.lang.Iterable<java.lang.Class<? extends com.google.inject.Module>> modules) Specify a set of module classes from which a set of additional modules may be derived using module dependencies.
LifecycleInjectorBuilder	withModules(java.lang.Iterable<? extends com.google.inject.Module> modules) Specify standard Guice modules for the main binding phase.
LifecycleInjectorBuilder	withModules(com.google.inject.Module... modules) Specify standard Guice modules for the main binding phase.
LifecycleInjectorBuilder	withModuleTransformer(java.util.Collection<? extends ModuleTransformer> transformer) Just before creating the injector all the modules will run through the filter.
LifecycleInjectorBuilder	withModuleTransformer(ModuleTransformer... transformer) Just before creating the injector all the modules will run through the filter.
LifecycleInjectorBuilder	withModuleTransformer(ModuleTransformer transformer) Just before creating the injector all the modules will run through the transformer.
LifecycleInjectorBuilder	withoutModuleClass(java.lang.Class<? extends com.google.inject.Module> module) When using module dependencies ignore the specified class
LifecycleInjectorBuilder	withoutModuleClasses(java.lang.Class<? extends com.google.inject.Module>... modules) When using module dependencies ignore the specified classes
LifecycleInjectorBuilder	withoutModuleClasses(java.lang.Iterable<java.lang.Class<? extends com.google.inject.Module>> modules) When using module dependencies ignore the specified classes
LifecycleInjectorBuilder	withPostInjectorAction(PostInjectorAction action) Action to perform after the injector is created.
LifecycleInjectorBuilder	withPostInjectorActions(java.util.Collection<? extends PostInjectorAction> action) Actions to perform after the injector is created.
LifecycleInjectorBuilder	withPostInjectorActions(PostInjectorAction... actions) Actions to perform after the injector is created.
LifecycleInjectorBuilder	withRootModule(java.lang.Class<?> mainModule) Deprecated.

Method Detail

withBootstrapModule

LifecycleInjectorBuilder withBootstrapModule(BootstrapModule module)

Specify a bootstrap module

Parameters:

module - the module

Returns:

this

withAdditionalBootstrapModules

LifecycleInjectorBuilder withAdditionalBootstrapModules(BootstrapModule... modules)

Specify additional bootstrap modules to use

Parameters:

modules - modules

Returns:

this

withAdditionalBootstrapModules

LifecycleInjectorBuilder withAdditionalBootstrapModules(java.lang.Iterable<? extends BootstrapModule> modules)

Specify additional bootstrap modules to use

Parameters:

modules - modules

Returns:

this

withModules

LifecycleInjectorBuilder withModules(com.google.inject.Module... modules)

Specify standard Guice modules for the main binding phase. Note that any modules provided in a previous call to withModules will be discarded. To add to the list of modules call withAdditionalModules(java.lang.Iterable<? extends com.google.inject.Module>)

Parameters:

modules - modules

Returns:

this

withModules

LifecycleInjectorBuilder withModules(java.lang.Iterable<? extends com.google.inject.Module> modules)

Specify standard Guice modules for the main binding phase. Note that any modules provided in a previous call to withModules will be discarded. To add to the list of modules call withAdditionalModules(java.lang.Iterable<? extends com.google.inject.Module>)

Parameters:

modules - modules

Returns:

this

withAdditionalModules

LifecycleInjectorBuilder withAdditionalModules(java.lang.Iterable<? extends com.google.inject.Module> modules)

Add to any modules already specified via withModules(Iterable)

Parameters:

modules - modules

Returns:

this

withAdditionalModules

LifecycleInjectorBuilder withAdditionalModules(com.google.inject.Module... modules)

Add to any modules already specified via withModules(Iterable)

Parameters:

modules - modules

Returns:

this

withRootModule

@Deprecated
LifecycleInjectorBuilder withRootModule(java.lang.Class<?> mainModule)

Deprecated.

Specify a root application module class from which a set of additional modules may be derived using module dependencies. Module dependencies are specified using @Inject on the module constructor and indicating the dependent modules as constructor arguments.

Parameters:

mainModule - root application module

Returns:

this

withModuleClass

LifecycleInjectorBuilder withModuleClass(java.lang.Class<? extends com.google.inject.Module> module)

Specify a module class from which a set of additional modules may be derived using module dependencies. Module dependencies are specified using @Inject on the module constructor and indicating the dependent modules as constructor arguments.

Parameters:

module - root application module

Returns:

this

withModuleClasses

LifecycleInjectorBuilder withModuleClasses(java.lang.Iterable<java.lang.Class<? extends com.google.inject.Module>> modules)

Specify a set of module classes from which a set of additional modules may be derived using module dependencies. Module dependencies are specified using @Inject on the module constructor and indicating the dependent modules as constructor arguments. Note that any existing modules that were added will be removed by this call

Parameters:

modules - root application modules

Returns:

this

withModuleClasses

LifecycleInjectorBuilder withModuleClasses(java.lang.Class<?>... modules)

Specify a set of module classes from which a set of additional modules may be derived using module dependencies. Module dependencies are specified using @Inject on the module constructor and indicating the dependent modules as constructor arguments. Note that any existing modules that were added will be removed by this call

Parameters:

modules - root application modules

Returns:

this

withAdditionalModuleClasses

LifecycleInjectorBuilder withAdditionalModuleClasses(java.lang.Iterable<java.lang.Class<? extends com.google.inject.Module>> modules)

Specify a set of module classes from which a set of additional modules may be derived using module dependencies. Module dependencies are specified using @Inject on the module constructor and indicating the dependent modules as constructor arguments. Note that any existing modules that were added will be removed by this call

Parameters:

modules - root application modules

Returns:

this

withAdditionalModuleClasses

LifecycleInjectorBuilder withAdditionalModuleClasses(java.lang.Class<?>... modules)

Specify a set of module classes from which a set of additional modules may be derived using module dependencies. Module dependencies are specified using @Inject on the module constructor and indicating the dependent modules as constructor arguments.

Parameters:

modules - root application modules

Returns:

this

withoutModuleClasses

LifecycleInjectorBuilder withoutModuleClasses(java.lang.Iterable<java.lang.Class<? extends com.google.inject.Module>> modules)

When using module dependencies ignore the specified classes

Parameters:

modules - to exclude

Returns:

this

withoutModuleClasses

LifecycleInjectorBuilder withoutModuleClasses(java.lang.Class<? extends com.google.inject.Module>... modules)

When using module dependencies ignore the specified classes

Parameters:

modules - to exclude

Returns:

this

withoutModuleClass

LifecycleInjectorBuilder withoutModuleClass(java.lang.Class<? extends com.google.inject.Module> module)

When using module dependencies ignore the specified class

Parameters:

module - to exclude

Returns:

this

ignoringAutoBindClasses

LifecycleInjectorBuilder ignoringAutoBindClasses(java.util.Collection<java.lang.Class<?>> ignoreClasses)

Specify specific AutoBindSingleton classes that should NOT be bound in the main binding phase

Parameters:

ignoreClasses - classes to not bind

Returns:

this

ignoringAllAutoBindClasses

LifecycleInjectorBuilder ignoringAllAutoBindClasses()

Do not bind ANY AutoBindSingleton classes

Returns:

this

usingBasePackages

LifecycleInjectorBuilder usingBasePackages(java.lang.String... basePackages)

Specify the base packages for CLASSPATH scanning. Packages are recursively scanned

Parameters:

basePackages - packages

Returns:

this

usingBasePackages

LifecycleInjectorBuilder usingBasePackages(java.util.Collection<java.lang.String> basePackages)

Specify the base packages for CLASSPATH scanning. Packages are recursively scanned

Parameters:

basePackages - packages

Returns:

this

usingClasspathScanner

LifecycleInjectorBuilder usingClasspathScanner(ClasspathScanner scanner)

Normally, the classpath scanner is allocated internally. This method allows for a custom scanner to be used. NOTE: Any packages specifies via usingBasePackages(String...) will be ignored if this method is called.

Parameters:

scanner - the scanner to use

Returns:

this

inStage

LifecycleInjectorBuilder inStage(com.google.inject.Stage stage)

Set the Guice stage - the default is Production

Parameters:

stage - new stage

Returns:

this

withMode

LifecycleInjectorBuilder withMode(LifecycleInjectorMode mode)

Set the lifecycle injector mode - default is LifecycleInjectorMode.REAL_CHILD_INJECTORS

Parameters:

mode - new mode

Returns:

this

withModuleTransformer

LifecycleInjectorBuilder withModuleTransformer(ModuleTransformer transformer)

Just before creating the injector all the modules will run through the transformer. Transformers will be executed in the order in which withModuleTransformer is called. Note that once the first filter is called subsequent calls will only be given the previous set of filtered modules.

Parameters:

transformer -

Returns:

this

withModuleTransformer

LifecycleInjectorBuilder withModuleTransformer(java.util.Collection<? extends ModuleTransformer> transformer)

Just before creating the injector all the modules will run through the filter. Transformers will be executed in the order in which withModuleTransformer is called. Note that once the first filter is called subsequent calls will only be given the previous set of filtered modules.

Parameters:

transformer -

Returns:

this

withModuleTransformer

LifecycleInjectorBuilder withModuleTransformer(ModuleTransformer... transformer)

Just before creating the injector all the modules will run through the filter. Transformers will be executed in the order in which withModuleTransformer is called. Note that once the first filter is called subsequent calls will only be given the previous set of filtered modules.

Parameters:

transformer -

Returns:

this

withPostInjectorAction

LifecycleInjectorBuilder withPostInjectorAction(PostInjectorAction action)

Action to perform after the injector is created. Note that post injection actions are performed in the same order as calls to withPostInjectorAction

Parameters:

action -

Returns:

withPostInjectorActions

LifecycleInjectorBuilder withPostInjectorActions(java.util.Collection<? extends PostInjectorAction> action)

Actions to perform after the injector is created. Note that post injection actions are performed in the same order as calls to withPostInjectorAction

Parameters:

action -

Returns:

withPostInjectorActions

LifecycleInjectorBuilder withPostInjectorActions(PostInjectorAction... actions)

Actions to perform after the injector is created. Note that post injection actions are performed in the same order as calls to withPostInjectorAction

Parameters:

action -

Returns:

build

LifecycleInjector build()

Build and return the injector

Returns:

LifecycleInjector

createInjector

@Deprecated
com.google.inject.Injector createInjector()

Deprecated. this API creates the "main" child injector. but it has the side effect of calling build() method that will create a new LifecycleInjector. Instead, you should just build() LifecycleInjector object. then call LifecycleInjector.createInjector() directly.

Internally build the LifecycleInjector and then return the result of calling LifecycleInjector.createInjector()

Returns:

Guice injector