org.elasticsearch.common.inject
Class PrivateModule

java.lang.Object
  org.elasticsearch.common.inject.PrivateModule

All Implemented Interfaces:

Module

public abstract class PrivateModule
extends Object
implements Module

A module whose configuration information is hidden from its environment by default. Only bindings that are explicitly exposed will be available to other modules and to the users of the injector. This module may expose the bindings it creates and the bindings of the modules it installs.

A private module can be nested within a regular module or within another private module using install(). Its bindings live in a new environment that inherits bindings, type converters, scopes, and interceptors from the surrounding ("parent") environment. When you nest multiple private modules, the result is a tree of environments where the injector's environment is the root.

Guice EDSL bindings can be exposed with expose(). @Provides bindings can be exposed with the @Exposed annotation:

 public class FooBarBazModule extends PrivateModule {
   protected void configure() {
     bind(Foo.class).to(RealFoo.class);
     expose(Foo.class);

     install(new TransactionalBarModule());
     expose(Bar.class).annotatedWith(Transactional.class);

     bind(SomeImplementationDetail.class);
     install(new MoreImplementationDetailsModule());
   }

   @Provides @Exposed
   public Baz provideBaz() {
     return new SuperBaz();
   }
 }
 

Private modules are implemented using parent injectors. When it can satisfy their dependencies, just-in-time bindings will be created in the root environment. Such bindings are shared among all environments in the tree.

The scope of a binding is constrained to its environment. A singleton bound in a private module will be unique to its environment. But a binding for the same type in a different private module will yield a different instance.

A shared binding that injects the Injector gets the root injector, which only has access to bindings in the root environment. An explicit binding that injects the Injector gets access to all bindings in the child environment.

To promote a just-in-time binding to an explicit binding, bind it:

   bind(FooImpl.class);
 

Since:

2.0

Author:

jessewilson@google.com (Jesse Wilson)

Constructor Summary

PrivateModule()

Method Summary

protected void	addError(Message message)
protected void	addError(String message, Object... arguments)
protected void	addError(Throwable t)
protected <T> AnnotatedBindingBuilder<T>	bind(Class<T> clazz)
protected <T> LinkedBindingBuilder<T>	bind(Key<T> key)
protected <T> AnnotatedBindingBuilder<T>	bind(TypeLiteral<T> typeLiteral)
protected AnnotatedConstantBindingBuilder	bindConstant()
protected PrivateBinder	binder() Returns the current binder.
protected void	bindListener(Matcher<? super TypeLiteral<?>> typeMatcher, TypeListener listener)
protected void	bindScope(Class<? extends Annotation> scopeAnnotation, Scope scope)
protected abstract void	configure() Creates bindings and other configurations private to this module.
void	configure(Binder binder) Contributes bindings and other configurations for this module to binder.
protected void	convertToTypes(Matcher<? super TypeLiteral<?>> typeMatcher, TypeConverter converter)
protected Stage	currentStage()
protected AnnotatedElementBuilder	expose(Class<?> type) Makes a binding for type available to other modules and the injector.
protected <T> void	expose(Key<T> key) Makes the binding for key available to other modules and the injector.
protected AnnotatedElementBuilder	expose(TypeLiteral<?> type) Makes a binding for type available to other modules and the injector.
protected <T> MembersInjector<T>	getMembersInjector(Class<T> type)
protected <T> MembersInjector<T>	getMembersInjector(TypeLiteral<T> type)
protected <T> Provider<T>	getProvider(Class<T> type)
protected <T> Provider<T>	getProvider(Key<T> key)
protected void	install(Module module)
protected void	requestInjection(Object instance)
protected void	requestStaticInjection(Class<?>... types)
protected void	requireBinding(Class<?> type) Instructs Guice to require a binding to the given type.
protected void	requireBinding(Key<?> key) Instructs Guice to require a binding to the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivateModule

public PrivateModule()

Method Detail

configure

public final void configure(Binder binder)

Description copied from interface: Module

Contributes bindings and other configurations for this module to binder.

Do not invoke this method directly to install submodules. Instead use Binder.install(Module), which ensures that provider methods are discovered.

Specified by:

configure in interface Module

configure

protected abstract void configure()

Creates bindings and other configurations private to this module. Use expose() to make the bindings in this module available externally.

expose

protected final <T> void expose(Key<T> key)

Makes the binding for key available to other modules and the injector.

expose

protected final AnnotatedElementBuilder expose(Class<?> type)

Makes a binding for type available to other modules and the injector. Use annotatedWith() to expose type with a binding annotation.

expose

protected final AnnotatedElementBuilder expose(TypeLiteral<?> type)

Makes a binding for type available to other modules and the injector. Use annotatedWith() to expose type with a binding annotation.

binder

protected final PrivateBinder binder()

Returns the current binder.

bindScope

protected final void bindScope(Class<? extends Annotation> scopeAnnotation,
                               Scope scope)

See Also:

Binder.bindScope(Class, Scope)

bind

protected final <T> LinkedBindingBuilder<T> bind(Key<T> key)

See Also:

Binder.bind(Key)

bind

protected final <T> AnnotatedBindingBuilder<T> bind(TypeLiteral<T> typeLiteral)

See Also:

Binder.bind(TypeLiteral)

bind

protected final <T> AnnotatedBindingBuilder<T> bind(Class<T> clazz)

See Also:

Binder.bind(Class)

bindConstant

protected final AnnotatedConstantBindingBuilder bindConstant()

See Also:

Binder.bindConstant()

install

protected final void install(Module module)

See Also:

Binder.install(Module)

addError

protected final void addError(String message,
                              Object... arguments)

See Also:

Binder.addError(String, Object[])

addError

protected final void addError(Throwable t)

See Also:

Binder.addError(Throwable)

addError

protected final void addError(Message message)

See Also:

Binder.addError(Message)

requestInjection

protected final void requestInjection(Object instance)

See Also:

Binder.requestInjection(Object)

requestStaticInjection

protected final void requestStaticInjection(Class<?>... types)

See Also:

Binder.requestStaticInjection(Class[])

requireBinding

protected final void requireBinding(Key<?> key)

Instructs Guice to require a binding to the given key.

requireBinding

protected final void requireBinding(Class<?> type)

Instructs Guice to require a binding to the given type.

getProvider

protected final <T> Provider<T> getProvider(Key<T> key)

See Also:

Binder.getProvider(Key)

getProvider

protected final <T> Provider<T> getProvider(Class<T> type)

See Also:

Binder.getProvider(Class)

convertToTypes

protected final void convertToTypes(Matcher<? super TypeLiteral<?>> typeMatcher,
                                    TypeConverter converter)

See Also:

Binder.convertToTypes(org.elasticsearch.common.inject.matcher.Matcher, org.elasticsearch.common.inject.spi.TypeConverter)

currentStage

protected final Stage currentStage()

See Also:

Binder.currentStage()

getMembersInjector

protected <T> MembersInjector<T> getMembersInjector(Class<T> type)

See Also:

Binder.getMembersInjector(Class)

getMembersInjector

protected <T> MembersInjector<T> getMembersInjector(TypeLiteral<T> type)

See Also:

Binder.getMembersInjector(TypeLiteral)

bindListener

protected void bindListener(Matcher<? super TypeLiteral<?>> typeMatcher,
                            TypeListener listener)

See Also:

Binder.bindListener(org.elasticsearch.common.inject.matcher.Matcher, org.elasticsearch.common.inject.spi.TypeListener)