akka.actor
Interface ActorPath

All Superinterfaces:

java.lang.Comparable<ActorPath>, java.io.Serializable

All Known Implementing Classes:

ChildActorPath, RootActorPath

public interface ActorPath
extends java.lang.Comparable<ActorPath>, scala.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.

Method Summary

Address	address() The Address under which this path can be reached; walks up the tree to the RootActorPath.
ActorPath	child(java.lang.String child) Java API: Create a new child actor path.
ActorPath	descendant(java.lang.Iterable<java.lang.String> names) Java API: Recursively create a descendant’s path by appending all child names.
scala.util.matching.Regex	ElementRegex() This Regular Expression is used to validate a path element (Actor Name).
scala.collection.Iterable<java.lang.String>	elements() Sequence of names for this path from root to this.
ActorPath	fromString(java.lang.String s) Parse string as actor path; throws java.net.MalformedURLException if unable to do so.
java.lang.Iterable<java.lang.String>	getElements() Java API: Sequence of names for this path from root to this.
java.lang.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.
java.lang.String	toStringWithAddress(Address address) Generate String representation, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

fromString

ActorPath fromString(java.lang.String s)

Parse string as actor path; throws java.net.MalformedURLException if unable to do so.

ElementRegex

scala.util.matching.Regex ElementRegex()

This Regular Expression is used to validate a path element (Actor Name). Since Actors form a tree, it is addressable using an URL, therefor an Actor Name has to conform to: http://www.ietf.org/rfc/rfc2396.txt

address

Address address()

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

name

java.lang.String name()

The name of the actor that this path refers to.

parent

ActorPath parent()

The path for the parent actor.

child

ActorPath child(java.lang.String child)

Java API: Create a new child actor path.

descendant

ActorPath descendant(java.lang.Iterable<java.lang.String> names)

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

elements

scala.collection.Iterable<java.lang.String> elements()

Sequence of names for this path from root to this. Performance implication: has to allocate a list.

getElements

java.lang.Iterable<java.lang.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.

toStringWithAddress

java.lang.String toStringWithAddress(Address address)

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