Module org.elasticsearch.server

Package org.elasticsearch.injection.guice

Class AbstractModule

java.lang.Object

org.elasticsearch.injection.guice.AbstractModule

All Implemented Interfaces:

Module

Direct Known Subclasses:

ActionModule, ClusterModule, DiscoveryModule, GatewayModule, IndicesModule

public abstract class AbstractModule
extends Object
implements Module

A support class for Modules which reduces repetition and results in a more readable configuration. Simply extend this class, implement configure(), and call the inherited methods which mirror those found in Binder. For example:

 public class MyModule extends AbstractModule {
   protected void configure() {
     bind(Service.class).to(ServiceImpl.class).in(Singleton.class);
     bind(CreditCardPaymentService.class);
     bind(PaymentService.class).to(CreditCardPaymentService.class);
     bindConstant().annotatedWith(Names.named("port")).to(8080);
   }
 }
 

Constructor Summary

Constructors

Constructor	Description
AbstractModule()

Method Summary

Modifier and Type	Method	Description
protected <T> AnnotatedBindingBuilder<T>	bind(Class<T> clazz)
protected <T> AnnotatedBindingBuilder<T>	bind(TypeLiteral<T> typeLiteral)
protected Binder	binder()	Gets direct access to the underlying Binder.
protected abstract void	configure()	Configures a Binder via the exposed methods.
final void	configure(Binder builder)	Contributes bindings and other configurations for this module to binder.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractModule

public AbstractModule()

Method Details

configure

public final void configure(Binder builder)

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).

Specified by:

configure in interface Module

configure

protected abstract void configure()

Configures a Binder via the exposed methods.

binder

protected Binder binder()

Gets direct access to the underlying Binder.

bind

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

See Also:

• Binder.bind(TypeLiteral)

bind

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

See Also:

• Binder.bind(Class)