Class Modules
- java.lang.Object
-
- org.elasticsearch.common.inject.util.Modules
-
public final class Modules extends java.lang.Object
Static utility methods for creating and working with instances ofModule
.- Since:
- 2.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Modules.OverriddenModuleBuilder
See the EDSL example atoverride()
.
-
Field Summary
Fields Modifier and Type Field Description static Module
EMPTY_MODULE
-
Method Summary
Modifier and Type Method Description static Module
combine(java.lang.Iterable<? extends Module> modules)
Returns a new module that installs all ofmodules
.static Module
combine(Module... modules)
Returns a new module that installs all ofmodules
.static Modules.OverriddenModuleBuilder
override(java.lang.Iterable<? extends Module> modules)
Returns a builder that creates a module that overlays override modules over the given modules.static Modules.OverriddenModuleBuilder
override(Module... modules)
Returns a builder that creates a module that overlays override modules over the given modules.
-
-
-
Field Detail
-
EMPTY_MODULE
public static final Module EMPTY_MODULE
-
-
Method Detail
-
override
public static Modules.OverriddenModuleBuilder override(Module... modules)
Returns a builder that creates a module that overlays override modules over the given modules. If a key is bound in both sets of modules, only the binding from the override modules is kept. This can be used to replace the bindings of a production module with test bindings:Module functionalTestModule = Modules.override(new ProductionModule()).with(new TestModule());
Prefer to write smaller modules that can be reused and tested without overrides.
- Parameters:
modules
- the modules whose bindings are open to be overridden
-
override
public static Modules.OverriddenModuleBuilder override(java.lang.Iterable<? extends Module> modules)
Returns a builder that creates a module that overlays override modules over the given modules. If a key is bound in both sets of modules, only the binding from the override modules is kept. This can be used to replace the bindings of a production module with test bindings:Module functionalTestModule = Modules.override(getProductionModules()).with(getTestModules());
Prefer to write smaller modules that can be reused and tested without overrides.
- Parameters:
modules
- the modules whose bindings are open to be overridden
-
combine
public static Module combine(Module... modules)
Returns a new module that installs all ofmodules
.
-
-