public class

AbstractEnvironmentModule

extends AbstractModule
java.lang.Object
   ↳ com.google.inject.AbstractModule
     ↳ uk.ac.imperial.presage2.util.environment.AbstractEnvironmentModule

Summary

Public Constructors
AbstractEnvironmentModule()

Module to bind components required for an AbstractEnvironment.

AbstractEnvironmentModule(Class<? extends AbstractEnvironment> environmentImplementation)

Module to bind components required for an AbstractEnvironment.

AbstractEnvironmentModule(Class<? extends AbstractEnvironment> environmentImplementation, Set<Class<? extends EnvironmentService>> environmentServices, Set<Class<? extends ActionHandler>> actionHandlers)

Module to bind components required for an AbstractEnvironment.

Public Methods
AbstractEnvironmentModule addActionHandler(Class<? extends ActionHandler> handler)
Add an ActionHandler to be bound to the environment.
AbstractEnvironmentModule addActionHandlers(Class...<? extends ActionHandler> handlers)
Add ActionHandlers to be bound to the environment.
AbstractEnvironmentModule addGlobalEnvironmentService(Class<? extends EnvironmentService> service)
Add a global environment service to be bound to the environment's service provider.
AbstractEnvironmentModule addGlobalEnvironmentServices(Class...<? extends EnvironmentService> services)
Add global environment services to be bound to the environment's service provider.
AbstractEnvironmentModule addParticipantEnvironmentService(Class<? extends EnvironmentService> service)
Add an EnvironmentService which will be provided to Participants on registration with the environment.
AbstractEnvironmentModule addParticipantEnvironmentServices(Class...<? extends EnvironmentService> services)
Add EnvironmentServices which will be provided to Participants on registration with the environment.
AbstractEnvironmentModule addParticipantGlobalEnvironmentService(Class<? extends EnvironmentService> service)
Add a global EnvironmentService which will be provided to Participants on registration with the environment.
AbstractEnvironmentModule addParticipantGlobalEnvironmentServices(Class...<? extends EnvironmentService> services)
Add global EnvironmentServices which will be provided to Participants on registration with the environment.
AbstractEnvironmentModule setStorage(Class<? extends SharedStateStorage> storage)
Protected Methods
void configure()
[Expand]
Inherited Methods
From class com.google.inject.AbstractModule
From class java.lang.Object
From interface com.google.inject.Module

Public Constructors

public AbstractEnvironmentModule ()

Module to bind components required for an AbstractEnvironment.

public AbstractEnvironmentModule (Class<? extends AbstractEnvironment> environmentImplementation)

Module to bind components required for an AbstractEnvironment.

Parameters
environmentImplementation Environment implementation to use.

public AbstractEnvironmentModule (Class<? extends AbstractEnvironment> environmentImplementation, Set<Class<? extends EnvironmentService>> environmentServices, Set<Class<? extends ActionHandler>> actionHandlers)

Module to bind components required for an AbstractEnvironment.

Parameters
environmentImplementation Environment implementation to use.
environmentServices Set of global EnvironmentServices to use.
actionHandlers Set of ActionHandlers to use.

Public Methods

public AbstractEnvironmentModule addActionHandler (Class<? extends ActionHandler> handler)

Add an ActionHandler to be bound to the environment.

Parameters
handler ActionHandler to bind.
Returns
  • this.

public AbstractEnvironmentModule addActionHandlers (Class...<? extends ActionHandler> handlers)

Add ActionHandlers to be bound to the environment.

Parameters
handlers ActionHandlers to bind.
Returns
  • this

public AbstractEnvironmentModule addGlobalEnvironmentService (Class<? extends EnvironmentService> service)

Add a global environment service to be bound to the environment's service provider.

Parameters
service EnvironmentService class to add
Returns
  • this

public AbstractEnvironmentModule addGlobalEnvironmentServices (Class...<? extends EnvironmentService> services)

Add global environment services to be bound to the environment's service provider.

Parameters
services EnvironmentService classes to add
Returns
  • this

public AbstractEnvironmentModule addParticipantEnvironmentService (Class<? extends EnvironmentService> service)

Add an EnvironmentService which will be provided to Participants on registration with the environment.

Returns
  • this

public AbstractEnvironmentModule addParticipantEnvironmentServices (Class...<? extends EnvironmentService> services)

Add EnvironmentServices which will be provided to Participants on registration with the environment.

Parameters
services EnvironmentServices to add.
Returns
  • this

public AbstractEnvironmentModule addParticipantGlobalEnvironmentService (Class<? extends EnvironmentService> service)

Add a global EnvironmentService which will be provided to Participants on registration with the environment.

Returns
  • this

public AbstractEnvironmentModule addParticipantGlobalEnvironmentServices (Class...<? extends EnvironmentService> services)

Add global EnvironmentServices which will be provided to Participants on registration with the environment.

Parameters
services EnvironmentServices to add.
Returns
  • this

public AbstractEnvironmentModule setStorage (Class<? extends SharedStateStorage> storage)

Protected Methods

protected void configure ()