root
API
Generated with
root/play/play.api/play.api.inject/Module

Module

play.api.inject.Module
abstract class Module

A Play dependency injection module.

Dependency injection modules can be used by Play plugins to provide bindings for JSR-330 compliant ApplicationLoaders. Any plugin that wants to provide components that a Play application can use may implement one of these.

Providing custom modules can be done by appending their fully qualified class names to play.modules.enabled in application.conf, for example

 play.modules.enabled += "com.example.FooModule"
 play.modules.enabled += "com.example.BarModule"

It is strongly advised that in addition to providing a module for JSR-330 DI, that plugins also provide a Scala trait that constructs the modules manually. This allows for use of the module without needing a runtime dependency injection provider.

The bind methods are provided only as a DSL for specifying bindings. For example:

 def bindings(env: Environment, conf: Configuration) = Seq(
   bind[Foo].to[FooImpl],
   bind[Bar].to(new Bar()),
   bind[Foo].qualifiedWith[SomeQualifier].to[OtherFoo]
 )

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class I18nModule
class SimpleModule
class AssetsModule
Show all

Members list

Value members

Abstract methods

def bindings(environment: Environment, configuration: Configuration): Seq[Binding[_]]

Get the bindings provided by this module.

Get the bindings provided by this module.

Implementations are strongly encouraged to do nothing in this method other than provide bindings. Startup should be handled in the constructors and/or providers bound in the returned bindings. Dependencies on other modules or components should be expressed through constructor arguments.

The configuration and environment a provided for the purpose of producing dynamic bindings, for example, if what gets bound depends on some configuration, this may be read to control that.

Value parameters

configuration

The configuration

environment

The environment

Attributes

Returns

A sequence of bindings

Concrete methods

final def bind[T : ClassTag]: BindingKey[T]

Create a binding key for the given class.

Create a binding key for the given class.

Attributes

Deprecated methods

final def bind[T](clazz: Class[T]): BindingKey[T]

Create a binding key for the given class.

Create a binding key for the given class.

Attributes

Deprecated
true
final def seq(bindings: Binding[_]*): Seq[Binding[_]]

Create a seq.

Create a seq.

For Java compatibility.

Attributes

Deprecated
true
Generated with