inject

Play's runtime dependency injection abstraction.

Play's runtime dependency injection support is built on JSR-330, which provides a specification for declaring how dependencies get wired to components. JSR-330 however does not address how components are provided to or located by a DI container. Play's API seeks to address this in a DI container agnostic way.

The reason for providing this abstraction is so that Play, the modules it provides, and third party modules can all express their bindings in a way that is not specific to any one DI container.

Components are bound in the DI container. Each binding is identified by a BindingKey, which is typically an interface that the component implements, and may be optionally qualified by a JSR-330 qualifier annotation. A binding key is bound to a BindingTarget, which describes how the implementation of the interface that the binding key represents is constructed or provided. Bindings may also be scoped using JSR-330 scope annotations.

Bindings are provided by instances of Module.

Out of the box, Play provides an implementation of this abstraction using Guice.

See also: The Module class for information on how to provide bindings.

Linear Supertypes

AnyRef, Any

Type Members

trait ApplicationLifecycle extends AnyRef

Application lifecycle register.
final case class Binding[T](key: BindingKey[T], target: Option[BindingTarget[T]], scope: Option[Class[_ <: Annotation]], eager: Boolean, source: AnyRef) extends Product with Serializable

A binding.
final case class BindingKey[T](clazz: Class[T], qualifier: Option[QualifierAnnotation]) extends Product with Serializable

A binding key.
final case class BindingKeyTarget[T](key: BindingKey[_ <: T]) extends BindingTarget[T] with Product with Serializable

A binding target that is provided by another key - essentially an alias.
sealed trait BindingTarget[T] extends AnyRef

A binding target.
class BuiltinModule extends Module

The Play BuiltinModule.
class ConfigurationProvider extends Provider[Configuration]
final case class ConstructionTarget[T](implementation: Class[_ <: T]) extends BindingTarget[T] with Product with Serializable

A binding target that is provided by a class.
class DefaultApplicationLifecycle extends ApplicationLifecycle

Default implementation of the application lifecycle.
trait Injector extends AnyRef

An injector, capable of providing components.
abstract class Module extends AnyRef

A Play dependency injection module.
class PluginsProvider extends Provider[Plugins]

Annotations
@Singleton()
final case class ProviderConstructionTarget[T](provider: Class[_ <: Provider[T]]) extends BindingTarget[T] with Product with Serializable

A binding target that is provided by a provider class.
final case class ProviderTarget[T](provider: Provider[_ <: T]) extends BindingTarget[T] with Product with Serializable

A binding target that is provided by a provider instance.
sealed trait QualifierAnnotation extends AnyRef

A qualifier annotation.
final case class QualifierClass[T <: Annotation](clazz: Class[T]) extends QualifierAnnotation with Product with Serializable

A qualifier annotation class.
final case class QualifierInstance[T <: Annotation](instance: T) extends QualifierAnnotation with Product with Serializable

A qualifier annotation instance.
class RoutesProvider extends Provider[Router]

Annotations
@Singleton()
class SimpleInjector extends Injector

A simple map backed injector.

Value Members

object BindingKey extends Serializable

Constructor for a binding Key that doesn't have a qualifier.
object Modules

Locates and loads modules from the Play environment.
object NewInstanceInjector extends Injector

An injector that simply creates a new instance of the passed in classes using the classes no-arg constructor.
def bind[T](implicit arg0: ClassTag[T]): BindingKey[T]

Create a binding key for the given class.
Create a binding key for the given class.

See also
The Module class for information on how to provide bindings.
def bind[T](clazz: Class[T]): BindingKey[T]

Create a binding key for the given class.
Create a binding key for the given class.

See also
The Module class for information on how to provide bindings.
package guice

package inject

Type Members

trait ApplicationLifecycle extends AnyRef

final case class Binding[T](key: BindingKey[T], target: Option[BindingTarget[T]], scope: Option[Class[_ <: Annotation]], eager: Boolean, source: AnyRef) extends Product with Serializable

final case class BindingKey[T](clazz: Class[T], qualifier: Option[QualifierAnnotation]) extends Product with Serializable

final case class BindingKeyTarget[T](key: BindingKey[_ <: T]) extends BindingTarget[T] with Product with Serializable

sealed trait BindingTarget[T] extends AnyRef

class BuiltinModule extends Module

class ConfigurationProvider extends Provider[Configuration]

final case class ConstructionTarget[T](implementation: Class[_ <: T]) extends BindingTarget[T] with Product with Serializable

class DefaultApplicationLifecycle extends ApplicationLifecycle

trait Injector extends AnyRef

abstract class Module extends AnyRef

class PluginsProvider extends Provider[Plugins]

final case class ProviderConstructionTarget[T](provider: Class[_ <: Provider[T]]) extends BindingTarget[T] with Product with Serializable

final case class ProviderTarget[T](provider: Provider[_ <: T]) extends BindingTarget[T] with Product with Serializable

sealed trait QualifierAnnotation extends AnyRef

final case class QualifierClass[T <: Annotation](clazz: Class[T]) extends QualifierAnnotation with Product with Serializable

final case class QualifierInstance[T <: Annotation](instance: T) extends QualifierAnnotation with Product with Serializable

class RoutesProvider extends Provider[Router]

class SimpleInjector extends Injector

Value Members

object BindingKey extends Serializable

object Modules

object NewInstanceInjector extends Injector

def bind[T](implicit arg0: ClassTag[T]): BindingKey[T]

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

package guice

Inherited from AnyRef

Inherited from Any

Ungrouped