Class

akka.actor

ExtensionKey

Related Doc: package actor

Permalink

abstract class ExtensionKey[T <: Extension] extends ExtensionId[T] with ExtensionIdProvider

This is a one-stop-shop if all you want is an extension which is constructed with the ExtendedActorSystem as its only constructor argument:

object MyExt extends ExtensionKey[Ext]

class Ext(system: ExtendedActorSystem) extends Extension {
  ...
}

Java API:

public class MyExt extends Extension {
  public static final ExtensionKey<MyExt> key = new ExtensionKey<MyExt>(MyExt.class);

  public MyExt(ExtendedActorSystem system) {
    ...
  }
}

Note: Don't use this class if the extension is written in Scala and consumed in Eclipse Java projects. JDT has problems resolving correct type for the get method.

Annotations
@deprecated
Deprecated

(Since version 2.5.0) Use a regular Extension instead

Source
Extension.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExtensionKey
  2. ExtensionIdProvider
  3. ExtensionId
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExtensionKey(clazz: Class[T])

    Permalink
  2. new ExtensionKey()(implicit m: ClassTag[T])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to any2stringadd[ExtensionKey[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ExtensionKey[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to ArrowAssoc[ExtensionKey[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def apply(system: ActorSystem): T

    Permalink

    Returns an instance of the extension identified by this ExtensionId instance.

    Returns an instance of the extension identified by this ExtensionId instance.

    Definition Classes
    ExtensionId
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def createExtension(system: ExtendedActorSystem): T

    Permalink

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Definition Classes
    ExtensionKeyExtensionId
  10. def ensuring(cond: (ExtensionKey[T]) ⇒ Boolean, msg: ⇒ Any): ExtensionKey[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to Ensuring[ExtensionKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ExtensionKey[T]) ⇒ Boolean): ExtensionKey[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to Ensuring[ExtensionKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): ExtensionKey[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to Ensuring[ExtensionKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ExtensionKey[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to Ensuring[ExtensionKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def equals(other: Any): Boolean

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to StringFormat[ExtensionKey[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. def get(system: ActorSystem): T

    Permalink

    Returns an instance of the extension identified by this ExtensionId instance.

    Returns an instance of the extension identified by this ExtensionId instance. Java API For extensions written in Scala that are to be used used from Java also, this method should be overridden to get correct return type.

    override def get(system: ActorSystem): TheExtension = super.get(system)
    Definition Classes
    ExtensionId
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def hashCode(): Int

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def lookup(): ExtensionId[T]

    Permalink

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

    Definition Classes
    ExtensionKeyExtensionIdProvider
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def [B](y: B): (ExtensionKey[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to ArrowAssoc[ExtensionKey[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ExtensionIdProvider

Inherited from ExtensionId[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ExtensionKey[T] to any2stringadd[ExtensionKey[T]]

Inherited by implicit conversion StringFormat from ExtensionKey[T] to StringFormat[ExtensionKey[T]]

Inherited by implicit conversion Ensuring from ExtensionKey[T] to Ensuring[ExtensionKey[T]]

Inherited by implicit conversion ArrowAssoc from ExtensionKey[T] to ArrowAssoc[ExtensionKey[T]]

Ungrouped