com.netflix.governator.guice

Class DelegatingLifecycleInjectorBuilder

java.lang.Object

com.netflix.governator.guice.DelegatingLifecycleInjectorBuilder

All Implemented Interfaces:

LifecycleInjectorBuilder

public class DelegatingLifecycleInjectorBuilder
extends java.lang.Object
implements LifecycleInjectorBuilder

Decorator for LifecycleInjectorBuilder which makes the original withModules methods additive instead of replacing any pre-defined module. This class also acts as a default implementation for overriding the behavior of LifecycleInjectorBuilder so that code does not break every time a new method is added.

Constructor Summary

Constructors

Constructor and Description
DelegatingLifecycleInjectorBuilder(LifecycleInjectorBuilder delegate)

Method Summary

Methods

Modifier and Type	Method and Description
LifecycleInjector	build() Build and return the injector
com.google.inject.Injector	createInjector() Deprecated.
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 LifecycleInjectorBuilder.withModules(Iterable)
LifecycleInjectorBuilder	withAdditionalModules(com.google.inject.Module... modules) Add to any modules already specified via LifecycleInjectorBuilder.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> transformers) Just before creating the injector all the modules will run through the filter.
LifecycleInjectorBuilder	withModuleTransformer(ModuleTransformer... transformers) 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> actions) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingLifecycleInjectorBuilder

public DelegatingLifecycleInjectorBuilder(LifecycleInjectorBuilder delegate)

Method Detail

withBootstrapModule

public LifecycleInjectorBuilder withBootstrapModule(BootstrapModule module)

Description copied from interface: LifecycleInjectorBuilder

Specify a bootstrap module

Specified by:

withBootstrapModule in interface LifecycleInjectorBuilder

Parameters:

module - the module

Returns:

this

withAdditionalBootstrapModules

public LifecycleInjectorBuilder withAdditionalBootstrapModules(BootstrapModule... modules)

Description copied from interface: LifecycleInjectorBuilder

Specify additional bootstrap modules to use

Specified by:

withAdditionalBootstrapModules in interface LifecycleInjectorBuilder

Parameters:

modules - modules

Returns:

this

withAdditionalBootstrapModules

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

Description copied from interface: LifecycleInjectorBuilder

Specify additional bootstrap modules to use

Specified by:

withAdditionalBootstrapModules in interface LifecycleInjectorBuilder

Parameters:

modules - modules

Returns:

this

withModules

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

Description copied from interface: LifecycleInjectorBuilder

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 LifecycleInjectorBuilder.withAdditionalModules(java.lang.Iterable<? extends com.google.inject.Module>)

Specified by:

withModules in interface LifecycleInjectorBuilder

Parameters:

modules - modules

Returns:

this

withModules

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

Description copied from interface: LifecycleInjectorBuilder

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 LifecycleInjectorBuilder.withAdditionalModules(java.lang.Iterable<? extends com.google.inject.Module>)

Specified by:

withModules in interface LifecycleInjectorBuilder

Parameters:

modules - modules

Returns:

this

withAdditionalModules

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

Description copied from interface: LifecycleInjectorBuilder

Add to any modules already specified via LifecycleInjectorBuilder.withModules(Iterable)

Specified by:

withAdditionalModules in interface LifecycleInjectorBuilder

Parameters:

modules - modules

Returns:

this

withAdditionalModules

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

Description copied from interface: LifecycleInjectorBuilder

Add to any modules already specified via LifecycleInjectorBuilder.withModules(Iterable)

Specified by:

withAdditionalModules in interface LifecycleInjectorBuilder

Parameters:

modules - modules

Returns:

this

withRootModule

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

Deprecated.

Description copied from interface: LifecycleInjectorBuilder

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.

Specified by:

withRootModule in interface LifecycleInjectorBuilder

Parameters:

mainModule - root application module

Returns:

this

withModuleClass

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

Description copied from interface: LifecycleInjectorBuilder

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.

Specified by:

withModuleClass in interface LifecycleInjectorBuilder

Parameters:

module - root application module

Returns:

this

withModuleClasses

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

withModuleClasses in interface LifecycleInjectorBuilder

Parameters:

modules - root application modules

Returns:

this

withModuleClasses

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

withModuleClasses in interface LifecycleInjectorBuilder

Parameters:

modules - root application modules

Returns:

this

withAdditionalModuleClasses

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

withAdditionalModuleClasses in interface LifecycleInjectorBuilder

Parameters:

modules - root application modules

Returns:

this

withAdditionalModuleClasses

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

Description copied from interface: LifecycleInjectorBuilder

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.

Specified by:

withAdditionalModuleClasses in interface LifecycleInjectorBuilder

Parameters:

modules - root application modules

Returns:

this

ignoringAutoBindClasses

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

ignoringAutoBindClasses in interface LifecycleInjectorBuilder

Parameters:

ignoreClasses - classes to not bind

Returns:

this

ignoringAllAutoBindClasses

public LifecycleInjectorBuilder ignoringAllAutoBindClasses()

Description copied from interface: LifecycleInjectorBuilder

Do not bind ANY AutoBindSingleton classes

Specified by:

ignoringAllAutoBindClasses in interface LifecycleInjectorBuilder

Returns:

this

usingBasePackages

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

usingBasePackages in interface LifecycleInjectorBuilder

Parameters:

basePackages - packages

Returns:

this

usingBasePackages

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

usingBasePackages in interface LifecycleInjectorBuilder

Parameters:

basePackages - packages

Returns:

this

usingClasspathScanner

public LifecycleInjectorBuilder usingClasspathScanner(ClasspathScanner scanner)

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

usingClasspathScanner in interface LifecycleInjectorBuilder

Parameters:

scanner - the scanner to use

Returns:

this

inStage

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

Description copied from interface: LifecycleInjectorBuilder

Set the Guice stage - the default is Production

Specified by:

inStage in interface LifecycleInjectorBuilder

Parameters:

stage - new stage

Returns:

this

withMode

public LifecycleInjectorBuilder withMode(LifecycleInjectorMode mode)

Description copied from interface: LifecycleInjectorBuilder

Set the lifecycle injector mode - default is LifecycleInjectorMode.REAL_CHILD_INJECTORS

Specified by:

withMode in interface LifecycleInjectorBuilder

Parameters:

mode - new mode

Returns:

this

withModuleTransformer

public LifecycleInjectorBuilder withModuleTransformer(ModuleTransformer transformer)

Description copied from interface: LifecycleInjectorBuilder

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.

Specified by:

withModuleTransformer in interface LifecycleInjectorBuilder

Returns:

this

withModuleTransformer

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

Description copied from interface: LifecycleInjectorBuilder

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.

Specified by:

withModuleTransformer in interface LifecycleInjectorBuilder

Returns:

this

withModuleTransformer

public LifecycleInjectorBuilder withModuleTransformer(ModuleTransformer... transformers)

Description copied from interface: LifecycleInjectorBuilder

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.

Specified by:

withModuleTransformer in interface LifecycleInjectorBuilder

Returns:

this

withPostInjectorAction

public LifecycleInjectorBuilder withPostInjectorAction(PostInjectorAction action)

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

withPostInjectorAction in interface LifecycleInjectorBuilder

Returns:

withPostInjectorActions

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

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

withPostInjectorActions in interface LifecycleInjectorBuilder

Returns:

withPostInjectorActions

public LifecycleInjectorBuilder withPostInjectorActions(PostInjectorAction... actions)

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

withPostInjectorActions in interface LifecycleInjectorBuilder

Returns:

withoutModuleClasses

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

Description copied from interface: LifecycleInjectorBuilder

When using module dependencies ignore the specified classes

Specified by:

withoutModuleClasses in interface LifecycleInjectorBuilder

Parameters:

modules - to exclude

Returns:

this

withoutModuleClasses

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

Description copied from interface: LifecycleInjectorBuilder

When using module dependencies ignore the specified classes

Specified by:

withoutModuleClasses in interface LifecycleInjectorBuilder

Parameters:

modules - to exclude

Returns:

this

withoutModuleClass

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

Description copied from interface: LifecycleInjectorBuilder

When using module dependencies ignore the specified class

Specified by:

withoutModuleClass in interface LifecycleInjectorBuilder

Parameters:

module - to exclude

Returns:

this

build

public LifecycleInjector build()

Description copied from interface: LifecycleInjectorBuilder

Build and return the injector

Specified by:

build in interface LifecycleInjectorBuilder

Returns:

LifecycleInjector

createInjector

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

Deprecated.

Description copied from interface: LifecycleInjectorBuilder

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

Specified by:

createInjector in interface LifecycleInjectorBuilder

Returns:

Guice injector