|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ActorPath
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.
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.collection.immutable.Iterable<java.lang.String> |
elements()
Sequence of names for this path from root to this. |
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 |
toSerializationFormat()
Generate full String representation including the uid for the actor cell instance as URI fragment. |
java.lang.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’s address includes host and port information. |
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. |
java.lang.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 Detail |
---|
Address address()
java.lang.String name()
ActorPath parent()
ActorPath child(java.lang.String child)
child
- (undocumented)
ActorPath descendant(java.lang.Iterable<java.lang.String> names)
names
- (undocumented)
scala.collection.immutable.Iterable<java.lang.String> elements()
java.lang.Iterable<java.lang.String> getElements()
RootActorPath root()
java.lang.String toStringWithoutAddress()
java.lang.String toStringWithAddress(Address address)
address
- (undocumented)
java.lang.String toSerializationFormat()
toString
.
java.lang.String toSerializationFormatWithAddress(Address address)
toStringWithAddress
.
address
- (undocumented)
int uid()
ActorPath withUid(int uid)
uid
.
uid
- (undocumented)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |