org.apache.druid.guice

Class DruidInjectorBuilder

java.lang.Object

org.apache.druid.guice.DruidInjectorBuilder

Direct Known Subclasses:

CoreInjectorBuilder, ExtensionInjectorBuilder, ServiceInjectorBuilder

public class DruidInjectorBuilder
extends Object

Druid-enabled injector builder which supports DruidModules, module classes created from the base injector, and filtering based on properties and LoadScope annotations.

Can be used in clients and tests, in which case no module filtering is done. Presumably, the test or client has already selected the modules that it needs.

Druid injector builders can be chained with an earlier builder providing a set of modules which a later builder overrides. Again, this is typically used only in the server, not in clients or tests.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.inject.Injector	baseInjector

Constructor Summary

Constructors

Constructor and Description
DruidInjectorBuilder(DruidInjectorBuilder from)
DruidInjectorBuilder(com.google.inject.Injector baseInjector)
DruidInjectorBuilder(com.google.inject.Injector baseInjector, Set<NodeRole> nodeRoles)

Method Summary

Modifier and Type	Method and Description
DruidInjectorBuilder	add(Object... input) Add an arbitrary set of modules.
DruidInjectorBuilder	addAll(List<? extends Object> inputs)
DruidInjectorBuilder	addClass(Class<?> input)
DruidInjectorBuilder	addInput(Object input) Add an arbitrary Module, DruidModule instance, or a subclass of these classes.
DruidInjectorBuilder	addModule(com.google.inject.Module module)
DruidInjectorBuilder	addModules(com.google.inject.Module... inputs)
com.google.inject.Injector	baseInjector()
com.google.inject.Injector	build()
DruidInjectorBuilder	ignoreLoadScopes() Ignore load scope annotations on modules.
List<com.google.inject.Module>	modules()

Methods inherited from class java.lang.Object

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

Field Detail

baseInjector

protected final com.google.inject.Injector baseInjector

Constructor Detail

DruidInjectorBuilder

public DruidInjectorBuilder(com.google.inject.Injector baseInjector)

DruidInjectorBuilder

public DruidInjectorBuilder(com.google.inject.Injector baseInjector,
                            Set<NodeRole> nodeRoles)

DruidInjectorBuilder

public DruidInjectorBuilder(DruidInjectorBuilder from)

Method Detail

ignoreLoadScopes

public DruidInjectorBuilder ignoreLoadScopes()

Ignore load scope annotations on modules. Primarily for testing where a unit test is not any Druid node, and may wish to load a module that is annotated with a load scope.

add

public DruidInjectorBuilder add(Object... input)

Add an arbitrary set of modules.

addModules

public DruidInjectorBuilder addModules(com.google.inject.Module... inputs)

addAll

public DruidInjectorBuilder addAll(List<? extends Object> inputs)

addInput

public DruidInjectorBuilder addInput(Object input)

Add an arbitrary Module, DruidModule instance, or a subclass of these classes. If a class is provided, it is instantiated using the base injector to allow dependency injection. If a module instance is provided, its members are injected. Note that such modules have visibility only to objects defined in the base injector, but not to objects defined in the injector being built.

addModule

public DruidInjectorBuilder addModule(com.google.inject.Module module)

addClass

public DruidInjectorBuilder addClass(Class<?> input)

modules

public List<com.google.inject.Module> modules()

build

public com.google.inject.Injector build()

baseInjector

public com.google.inject.Injector baseInjector()