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
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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    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)
    Implicit
    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
    Definition Classes
    AnyRef → Any
  6. 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
  7. 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
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  10. 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
    ExtensionKeyExtensionId
  11. def ensuring(cond: (ExtensionKey[T]) ⇒ Boolean, msg: ⇒ Any): ExtensionKey[T]
    Implicit
    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: (ExtensionKey[T]) ⇒ Boolean): ExtensionKey[T]
    Implicit
    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, msg: ⇒ Any): ExtensionKey[T]
    Implicit
    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. def ensuring(cond: Boolean): ExtensionKey[T]
    Implicit
    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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def equals(other: Any): Boolean
    Definition Classes
    ExtensionId → AnyRef → Any
  17. def formatted(fmtstr: String): String
    Implicit
    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: 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
  19. 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
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def hashCode(): Int
    Definition Classes
    ExtensionId → AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def lookup(): ExtensionId[T]

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

    Definition Classes
    ExtensionKeyExtensionIdProvider
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (ExtensionKey[T], B)
    Implicit
    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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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