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
- Alphabetic
- By Inheritance
- ActorPath
- Serializable
- Comparable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def /(child: String): ActorPath
Create a new child actor path.
- abstract def address: Address
The Address under which this path can be reached; walks up the tree to the RootActorPath.
- abstract def compareTo(arg0: ActorPath): Int
- Definition Classes
- Comparable
- 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.
- abstract def name: String
The name of the actor that this path refers to.
- abstract def parent: ActorPath
The path for the parent actor.
- abstract def root: RootActorPath
Walk up the tree to obtain and return the RootActorPath.
- 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. - 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. - 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (ActorPath, B)
- def /(child: Iterable[String]): ActorPath
Recursively create a descendant’s path by appending all child names.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def child(child: String): ActorPath
Java API: Create a new child actor path.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def descendant(names: Iterable[String]): ActorPath
Java API: Recursively create a descendant’s path by appending all child names.
- def ensuring(cond: (ActorPath) => Boolean, msg: => Any): ActorPath
- def ensuring(cond: (ActorPath) => Boolean): ActorPath
- def ensuring(cond: Boolean, msg: => Any): ActorPath
- def ensuring(cond: Boolean): ActorPath
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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".
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.