Package org.apache.pekko.actor

Interface ActorPath

All Superinterfaces:
Comparable<ActorPath>, Serializable
All Known Implementing Classes:
ChildActorPath, RootActorPath
public interface ActorPath extends Comparable<ActorPath>, 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 &gt; 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.

  • Method Summary

    Modifier and Type
    Method
    Description
    ActorPath
    $div(String child)
    Create a new child actor path.
    ActorPath
    $div(scala.collection.Iterable<String> child)
    Recursively create a descendant&rsquo;s path by appending all child names.
    Address
    address()
    The Address under which this path can be reached; walks up the tree to the RootActorPath.
    ActorPath
    child(String child)
    Java API: Create a new child actor path.
    ActorPath
    descendant(Iterable<String> names)
    Java API: Recursively create a descendant&rsquo;s path by appending all child names.
    scala.collection.immutable.Iterable<String>
    elements()
    Sequence of names for this path from root to this.
    Iterable<String>
    getElements()
    Java API: Sequence of names for this path from root to this.
    String
    name()
    The name of the actor that this path refers to.
    ActorPath
    parent()
    The path for the parent actor.
    RootActorPath
    root()
    Walk up the tree to obtain and return the RootActorPath.
    String
    toSerializationFormat()
    Generate full String representation including the uid for the actor cell instance as URI fragment.
    String
    toSerializationFormatWithAddress(Address address)
    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&rsquo;s address includes host and port information.
    String
    toStringWithAddress(Address address)
    Generate String representation, replacing the Address in the RootActor Path with the given one unless this path&rsquo;s address includes host and port information.
    String
    toStringWithoutAddress()
    String representation of the path elements, excluding the address information.
    int
    uid()
    INTERNAL API Unique identifier of the actor.
    ActorPath
    withUid(int uid)
    INTERNAL API Creates a new ActorPath with same elements but with the specified uid.

    Methods inherited from interface java.lang.Comparable

    compareTo

  • Method Details

    • address

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

    • name

      String name()
      The name of the actor that this path refers to.

    • parent

      ActorPath parent()
      The path for the parent actor.

    • $div

      ActorPath $div(String child)
      Create a new child actor path.

    • child

      ActorPath child(String child)
      Java API: Create a new child actor path.

    • $div

      ActorPath $div(scala.collection.Iterable<String> child)
      Recursively create a descendant&rsquo;s path by appending all child names.

    • descendant

      ActorPath descendant(Iterable<String> names)
      Java API: Recursively create a descendant&rsquo;s path by appending all child names.

    • elements

      scala.collection.immutable.Iterable<String> elements()
      Sequence of names for this path from root to this. Performance implication: has to allocate a list.

    • getElements

      Iterable<String> getElements()
      Java API: Sequence of names for this path from root to this. Performance implication: has to allocate a list.

    • root

      RootActorPath root()
      Walk up the tree to obtain and return the RootActorPath.

    • toStringWithoutAddress

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

    • toStringWithAddress

      String toStringWithAddress(Address address)
      Generate String representation, replacing the Address in the RootActor Path with the given one unless this path&rsquo;s address includes host and port information.

    • toSerializationFormat

      String toSerializationFormat()
      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.

    • toSerializationFormatWithAddress

      String toSerializationFormatWithAddress(Address address)
      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&rsquo;s address includes host and port information. This representation should be used as serialized representation instead of toStringWithAddress.

    • uid

      int uid()
      INTERNAL API Unique identifier of the actor. Used for distinguishing different incarnations of actors with same path (name elements).

    • withUid

      ActorPath withUid(int uid)
      INTERNAL API Creates a new ActorPath with same elements but with the specified uid.