akka.actor
Class RootActorPath

java.lang.Object
  akka.actor.RootActorPath

All Implemented Interfaces:

ActorPath, java.io.Serializable, java.lang.Comparable<ActorPath>, scala.Equals, scala.Product

public final class RootActorPath
extends java.lang.Object
implements ActorPath, scala.Product, scala.Serializable

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

See Also:

Serialized Form

Constructor Summary

RootActorPath(Address address, java.lang.String name)

Method Summary

Address	address() The Address under which this path can be reached; walks up the tree to the RootActorPath.
int	compareTo(ActorPath other)
scala.collection.immutable.Iterable<java.lang.String>	elements() 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 addr) 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.
java.lang.String	toString()
java.lang.String	toStringWithAddress(Address addr) 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.
int	uid() INTERNAL API
ActorPath	withUid(int uid) INTERNAL API

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.actor.ActorPath

child, descendant, getElements, toStringWithoutAddress

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

RootActorPath

public RootActorPath(Address address,
                     java.lang.String name)

Method Detail

address

public Address address()

Description copied from interface: ActorPath

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

Specified by:

address in interface ActorPath

Returns:

(undocumented)

name

public java.lang.String name()

Description copied from interface: ActorPath

The name of the actor that this path refers to.

Specified by:

name in interface ActorPath

Returns:

(undocumented)

parent

public ActorPath parent()

Description copied from interface: ActorPath

The path for the parent actor.

Specified by:

parent in interface ActorPath

Returns:

(undocumented)

root

public RootActorPath root()

Description copied from interface: ActorPath

Walk up the tree to obtain and return the RootActorPath.

Specified by:

root in interface ActorPath

Returns:

(undocumented)

elements

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

Description copied from interface: ActorPath

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

Specified by:

elements in interface ActorPath

Returns:

(undocumented)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toSerializationFormat

public java.lang.String toSerializationFormat()

Description copied from interface: ActorPath

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.

Specified by:

toSerializationFormat in interface ActorPath

Returns:

(undocumented)

toStringWithAddress

public java.lang.String toStringWithAddress(Address addr)

Description copied from interface: ActorPath

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.

Specified by:

toStringWithAddress in interface ActorPath

Parameters:

addr - (undocumented)

Returns:

(undocumented)

toSerializationFormatWithAddress

public java.lang.String toSerializationFormatWithAddress(Address addr)

Description copied from interface: ActorPath

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.

Specified by:

toSerializationFormatWithAddress in interface ActorPath

Parameters:

addr - (undocumented)

Returns:

(undocumented)

compareTo

public int compareTo(ActorPath other)

Specified by:

compareTo in interface java.lang.Comparable<ActorPath>

uid

public int uid()

INTERNAL API

Specified by:

uid in interface ActorPath

Returns:

(undocumented)

withUid

public ActorPath withUid(int uid)

INTERNAL API

Specified by:

withUid in interface ActorPath

Parameters:

uid - (undocumented)

Returns:

(undocumented)