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
Linear Supertypes
Serializable, Comparable[ActorPath], AnyRef, Any
Known Subclasses
ChildActorPath, RootActorPath
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. def /(child: Iterable[String]): ActorPath

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

  2. def child(child: String): ActorPath

    Java API: Create a new child actor path.

  3. def descendant(names: Iterable[String]): ActorPath

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

  4. 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()
  5. 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".