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

A binding key.

A binding key consists of a class and zero or more JSR-330 qualifiers.

clazz

The class to bind.

qualifier

An optional qualifier.

Source
Binding.scala
See also

The Module class for information on how to provide bindings.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BindingKey
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BindingKey(clazz: Class[T])
  2. new BindingKey(clazz: Class[T], qualifier: Option[QualifierAnnotation])

    clazz

    The class to bind.

    qualifier

    An optional qualifier.

Value Members

  1. def asJava: inject.BindingKey[T]
  2. val clazz: Class[T]
  3. def productElementNames: Iterator[String]
    Definition Classes
    Product
  4. def qualifiedWith(name: String): BindingKey[T]

    Qualify this binding key with the given name.

    Qualify this binding key with the given name.

    For example, you may have both a cached implementation, and a direct implementation of a service. To differentiate between them, you may decide to name the cached one:

    bind[Foo].qualifiedWith("cached").to[FooCached],
bind[Foo].to[FooImpl]

...

class MyController @Inject() (@Named("cached") foo: Foo) {
  ...
}

    In the above example, the controller will get the cached Foo service.

  5. def qualifiedWith[A <: Annotation](implicit arg0: ClassTag[A]): BindingKey[T]

    Qualify this binding key with the given annotation.

    Qualify this binding key with the given annotation.

    For example, you may have both a cached implementation, and a direct implementation of a service. To differentiate between them, you may define a Cached annotation:

    import scala.annotation._

@target.param
class Cached extends StaticAnnotation

...

bind[Foo].qualifiedWith[Cached].to[FooCached],
bind[Foo].to[FooImpl]

...

class MyController @Inject() (@Cached foo: Foo) {
  ...
}

    In the above example, the controller will get the cached Foo service.

  6. def qualifiedWith[A <: Annotation](annotation: Class[A]): BindingKey[T]

    Qualify this binding key with the given annotation.

    Qualify this binding key with the given annotation.

    For example, you may have both a cached implementation, and a direct implementation of a service. To differentiate between them, you may define a Cached annotation:

    import scala.annotation._

@target.param
class Cached extends StaticAnnotation

...

bind[Foo].qualifiedWith(classOf[Cached]).to[FooCached],
bind[Foo].to[FooImpl]

...

class MyController @Inject() (@Cached foo: Foo) {
  ...
}

    In the above example, the controller will get the cached Foo service.

  7. def qualifiedWith[A <: Annotation](instance: A): BindingKey[T]

    Qualify this binding key with the given instance of an annotation.

    Qualify this binding key with the given instance of an annotation.

    This can be used to specify bindings with annotations that have particular values.

  8. val qualifier: Option[QualifierAnnotation]
  9. def to(key: BindingKey[_ <: T]): Binding[T]

    Bind this binding key to another binding key.

  10. def to[A <: T](instance: => A): Binding[T]

    Bind this binding key to the given instance.

  11. def to(provider: Provider[_ <: T]): Binding[T]

    Bind this binding key to the given provider instance.

    Bind this binding key to the given provider instance.

    This provider instance will be invoked to obtain the implementation for the key.

  12. def to[C <: T](implicit arg0: ClassTag[C]): Binding[T]

    Bind this binding key to the given implementation class.

    Bind this binding key to the given implementation class.

    This class will be instantiated and injected by the injection framework.

  13. def to(implementation: Class[_ <: T]): Binding[T]

    Bind this binding key to the given implementation class.

    Bind this binding key to the given implementation class.

    This class will be instantiated and injected by the injection framework.

  14. def toInstance(instance: T): Binding[T]

    Bind this binding key to the given instance.

  15. def toProvider[P <: Provider[_ <: T]](implicit arg0: ClassTag[P]): Binding[T]

    Bind this binding key to the given provider class.

    Bind this binding key to the given provider class.

    The dependency injection framework will instantiate and inject this provider, and then invoke its get method whenever an instance of the class is needed.

  16. def toProvider[P <: Provider[_ <: T]](provider: Class[P]): Binding[T]

    Bind this binding key to the given provider class.

    Bind this binding key to the given provider class.

    The dependency injection framework will instantiate and inject this provider, and then invoke its get method whenever an instance of the class is needed.

  17. def toSelf: Binding[T]

    Bind this binding key to itself.

  18. def toString(): String
    Definition Classes
    BindingKey → AnyRef → Any