Packages

c

akka.actor

ExtensionKey

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
ExtensionIdProvider, ExtensionId[T], AnyRef, Any
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])
  2. new ExtensionKey()(implicit m: ClassTag[T])

Value Members

  1. def apply(system: ClassicActorSystemProvider): T

    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
  2. def apply(system: ActorSystem): T

    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
  3. def createExtension(system: ExtendedActorSystem): T

    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
    ExtensionKey → ExtensionId
  4. final def equals(other: Any): Boolean
    Definition Classes
    ExtensionId → AnyRef → Any
  5. def get(system: ClassicActorSystemProvider): T

    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 from Java also, this method should be overridden to get correct return type.

    override def get(system: ClassicActorSystemProvider): TheExtension = super.get(system)
    Definition Classes
    ExtensionId
  6. def get(system: ActorSystem): T

    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 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
  7. final def hashCode(): Int
    Definition Classes
    ExtensionId → AnyRef → Any
  8. def lookup(): ExtensionId[T]

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

    Definition Classes
    ExtensionKey → ExtensionIdProvider