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.

Source
Extension.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExtensionKey
  2. ExtensionIdProvider
  3. ExtensionId
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. 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
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. 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
  12. def ensuring(cond: (ExtensionKey[T]) ⇒ Boolean, msg: ⇒ Any): ExtensionKey[T]

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

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

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

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. 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 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
  21. final def getClass(): Class[_]

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

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

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

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

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

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  29. def toString(): String

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

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

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

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (extensionKey: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (extensionKey: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ExtensionKey[T]

    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to ArrowAssoc[ExtensionKey[T]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (extensionKey: ArrowAssoc[ExtensionKey[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ExtensionKey[T]

    Implicit information
    This member is added by an implicit conversion from ExtensionKey[T] to Ensuring[ExtensionKey[T]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (extensionKey: Ensuring[ExtensionKey[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ExtensionIdProvider

Inherited from ExtensionId[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped