Packages

c

org.apache.pekko.actor

RootActorPath

final case class RootActorPath(address: Address, name: String = "/") extends ActorPath with Product with Serializable

Root of the hierarchy of ActorPaths. There is exactly root per ActorSystem and node (for remote-enabled or clustered systems).

Annotations
@SerialVersionUID()
Source
ActorPath.scala
Linear Supertypes
Product, Equals, ActorPath, Serializable, Comparable[ActorPath], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RootActorPath
  2. Product
  3. Equals
  4. ActorPath
  5. Serializable
  6. Comparable
  7. AnyRef
  8. 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

Instance Constructors

  1. new RootActorPath(address: Address, name: String = "/")

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

    Create a new child actor path.

    Create a new child actor path.

    Definition Classes
    RootActorPath → ActorPath
  6. def /(child: Iterable[String]): ActorPath

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

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

    Definition Classes
    ActorPath
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. val address: Address

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

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

    Definition Classes
    RootActorPath → ActorPath
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def child(child: String): ActorPath

    Java API: Create a new child actor path.

    Java API: Create a new child actor path.

    Definition Classes
    ActorPath
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def compareTo(other: ActorPath): Int
    Definition Classes
    RootActorPath → Comparable
  13. def descendant(names: Iterable[String]): ActorPath

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

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

    Definition Classes
    ActorPath
  14. 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.

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

    Definition Classes
    ActorPath
    Annotations
    @nowarn()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val name: String

    The name of the actor that this path refers to.

    The name of the actor that this path refers to.

    Definition Classes
    RootActorPath → ActorPath
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. def parent: ActorPath

    The path for the parent actor.

    The path for the parent actor.

    Definition Classes
    RootActorPath → ActorPath
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def root: RootActorPath

    Walk up the tree to obtain and return the RootActorPath.

    Walk up the tree to obtain and return the RootActorPath.

    Definition Classes
    RootActorPath → ActorPath
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. val 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.

    Definition Classes
    RootActorPath → ActorPath
  32. def toSerializationFormatWithAddress(addr: 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.

    Definition Classes
    RootActorPath → ActorPath
  33. val toString: String
    Definition Classes
    RootActorPath → AnyRef → Any
  34. def toStringWithAddress(addr: 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.

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

    Definition Classes
    RootActorPath → ActorPath
  35. 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".

    Definition Classes
    ActorPath
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. 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 RootActorPath toStringFormat[RootActorPath] 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): (RootActorPath, B)
    Implicit
    This member is added by an implicit conversion from RootActorPath toArrowAssoc[RootActorPath] 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 Product

Inherited from Equals

Inherited from ActorPath

Inherited from Serializable

Inherited from Comparable[ActorPath]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRootActorPath to any2stringadd[RootActorPath]

Inherited by implicit conversion StringFormat fromRootActorPath to StringFormat[RootActorPath]

Inherited by implicit conversion Ensuring fromRootActorPath to Ensuring[RootActorPath]

Inherited by implicit conversion ArrowAssoc fromRootActorPath to ArrowAssoc[RootActorPath]

Ungrouped