Packages

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
@nowarn() @SerialVersionUID()
Source
ActorPath.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorPath
  2. Serializable
  3. Comparable
  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. Protected

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: 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 ActorPath toany2stringadd[ActorPath] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorPath, B)
    Implicit
    This member is added by an implicit conversion from ActorPath toArrowAssoc[ActorPath] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def /(child: Iterable[String]): ActorPath

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

  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def child(child: String): ActorPath

    Java API: Create a new child actor path.

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def descendant(names: Iterable[String]): ActorPath

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

  11. def ensuring(cond: (ActorPath) => Boolean, msg: => Any): ActorPath
    Implicit
    This member is added by an implicit conversion from ActorPath toEnsuring[ActorPath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ActorPath) => Boolean): ActorPath
    Implicit
    This member is added by an implicit conversion from ActorPath toEnsuring[ActorPath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ActorPath
    Implicit
    This member is added by an implicit conversion from ActorPath toEnsuring[ActorPath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ActorPath
    Implicit
    This member is added by an implicit conversion from ActorPath toEnsuring[ActorPath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. 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.

    Annotations
    @nowarn()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. 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".

  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ActorPath toStringFormat[ActorPath] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (ActorPath, B)
    Implicit
    This member is added by an implicit conversion from ActorPath toArrowAssoc[ActorPath] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Comparable[ActorPath]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromActorPath to any2stringadd[ActorPath]

Inherited by implicit conversion StringFormat fromActorPath to StringFormat[ActorPath]

Inherited by implicit conversion Ensuring fromActorPath to Ensuring[ActorPath]

Inherited by implicit conversion ArrowAssoc fromActorPath to ArrowAssoc[ActorPath]

Ungrouped