akka.actor

ActorPath

sealed trait ActorPath extends Comparable[ActorPath] with Serializable

Actor path is a unique path to an actor that shows the creation path up through the actor tree to the root actor.

ActorPath defines a natural ordering (so that ActorRefs can be put into collections with this requirement); this ordering is intended to be as fast as possible, which owing to the bottom-up recursive nature of ActorPath is sorted by path elements FROM RIGHT TO LEFT, where RootActorPath > ChildActorPath in case the number of elements is different.

Two actor paths are compared equal when they have the same name and parent elements, including the root address information. That does not necessarily mean that they point to the same incarnation of the actor if the actor is re-created with the same path. In other words, in contrast to how actor references are compared the unique id of the actor is not taken into account when comparing actor paths.

Annotations
@SerialVersionUID( 1L )
Source
ActorPath.scala
Linear Supertypes
Serializable, Serializable, Comparable[ActorPath], AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActorPath
  2. Serializable
  3. Serializable
  4. Comparable
  5. AnyRef
  6. 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

Abstract Value Members

  1. abstract def /(child: String): ActorPath

    Create a new child actor path.

  2. abstract def address: Address

    The Address under which this path can be reached; walks up the tree to the RootActorPath.

  3. abstract def compareTo(arg0: ActorPath): Int

    Definition Classes
    Comparable
  4. abstract def elements: Iterable[String]

    Sequence of names for this path from root to this.

    Sequence of names for this path from root to this. Performance implication: has to allocate a list.

  5. abstract def name: String

    The name of the actor that this path refers to.

  6. abstract def parent: ActorPath

    The path for the parent actor.

  7. abstract def root: RootActorPath

    Walk up the tree to obtain and return the RootActorPath.

  8. abstract def toSerializationFormat: String

    Generate full String representation including the uid for the actor cell instance as URI fragment.

    Generate full String representation including the uid for the actor cell instance as URI fragment. This representation should be used as serialized representation instead of toString.

  9. abstract def toSerializationFormatWithAddress(address: Address): String

    Generate full String representation including the uid for the actor cell instance as URI fragment, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information.

    Generate full String representation including the uid for the actor cell instance as URI fragment, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information. This representation should be used as serialized representation instead of toStringWithAddress.

  10. abstract def toStringWithAddress(address: Address): String

    Generate String representation, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information.

Concrete 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 ActorPath to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ActorPath, B)

    Implicit information
    This member is added by an implicit conversion from ActorPath to ArrowAssoc[ActorPath] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. def /(child: Iterable[String]): ActorPath

    Recursively create a descendant’s path by appending all child names.

  7. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def child(child: String): ActorPath

    Java API: Create a new child actor path.

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def descendant(names: Iterable[String]): ActorPath

    Java API: Recursively create a descendant’s path by appending all child names.

  13. def ensuring(cond: (ActorPath) ⇒ Boolean, msg: ⇒ Any): ActorPath

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

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

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

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

    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

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

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

    Implicit information
    This member is added by an implicit conversion from ActorPath to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def getElements: Iterable[String]

    Java API: Sequence of names for this path from root to this.

    Java API: Sequence of names for this path from root to this. Performance implication: has to allocate a list.

  23. def hashCode(): Int

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

    Definition Classes
    Any
  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. def toStringWithoutAddress: String

    String representation of the path elements, excluding the address information.

    String representation of the path elements, excluding the address information. The elements are separated with "/" and starts with "/", e.g. "/user/a/b".

  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (ActorPath, B)

    Implicit information
    This member is added by an implicit conversion from ActorPath to ArrowAssoc[ActorPath] 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 ActorPath 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:
    (actorPath: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorPath 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:
    (actorPath: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ActorPath

    Implicit information
    This member is added by an implicit conversion from ActorPath to ArrowAssoc[ActorPath] 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:
    (actorPath: ArrowAssoc[ActorPath]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ActorPath

    Implicit information
    This member is added by an implicit conversion from ActorPath to Ensuring[ActorPath] 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:
    (actorPath: Ensuring[ActorPath]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Comparable[ActorPath]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorPath to StringAdd

Inherited by implicit conversion any2stringfmt from ActorPath to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ActorPath to ArrowAssoc[ActorPath]

Inherited by implicit conversion any2Ensuring from ActorPath to Ensuring[ActorPath]

Ungrouped