com.spotify.apollo.module

Class AbstractApolloModule

java.lang.Object

com.google.inject.AbstractModule

com.spotify.apollo.module.AbstractApolloModule

All Implemented Interfaces:

com.google.inject.Module, ApolloModule

Direct Known Subclasses:

ApolloEnvironmentModule, HttpClientModule, HttpServerModule, SlackModule

public abstract class AbstractApolloModule
extends com.google.inject.AbstractModule
implements ApolloModule

A base implementation of an Apollo module.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApolloModule()

Method Summary

Modifier and Type	Method and Description
Set<? extends com.google.inject.Key<?>>	getLifecycleManaged() Returns the immutable, idempotently determined and stable set of injection keys that should be bound to the service lifecycle; i.e.
double	getPriority() Returns the priority of this module relative to other modules.
protected void	manageLifecycle(Class<?> cls)
protected void	manageLifecycle(com.google.inject.Key<?> key)
String	toString()

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.spotify.apollo.module.ApolloModule

getId

Methods inherited from interface com.google.inject.Module

configure

Constructor Detail

AbstractApolloModule

protected AbstractApolloModule()

Method Detail

manageLifecycle

protected void manageLifecycle(com.google.inject.Key<?> key)

manageLifecycle

protected void manageLifecycle(Class<?> cls)

getPriority

public double getPriority()

Description copied from interface: ApolloModule

Returns the priority of this module relative to other modules. A higher priority means that initialization will happen earlier for this module. This only matters for independent components of module dependencies; dependencies will always be initialized before the dependees. The default ("don't care") priority is 0.0.

Specified by:

getPriority in interface ApolloModule

Returns:

the priority of this module relative to other modules.

getLifecycleManaged

public Set<? extends com.google.inject.Key<?>> getLifecycleManaged()

Description copied from interface: ApolloModule

Returns the immutable, idempotently determined and stable set of injection keys that should be bound to the service lifecycle; i.e. created on service start-up and destroyed on shutdown. All the instances for the keys returned by this method that implement Closeable will be closed on shutdown.

Specified by:

getLifecycleManaged in interface ApolloModule

Returns:

the set of injection keys that should be bound to the service lifecycle.

toString

public String toString()

Overrides:

toString in class Object