org.agilewiki.jid.scalar.vlens.actor

Class RootJid

java.lang.Object

org.agilewiki.jactor.lpc.JLPCActor

org.agilewiki.jid.Jid

org.agilewiki.jid.scalar.ScalarJid<SET_TYPE,RESPONSE_TYPE>

org.agilewiki.jid.scalar.vlens.VLenScalarJid<String,Jid>

org.agilewiki.jid.scalar.vlens.actor.ActorJid

org.agilewiki.jid.scalar.vlens.actor.RootJid

All Implemented Interfaces:

org.agilewiki.jactor.Actor, org.agilewiki.jactor.apc.APCRequestSource, org.agilewiki.jactor.apc.RequestProcessor, org.agilewiki.jactor.lpc.RequestSource, org.agilewiki.jactor.lpc.TargetActor, _Jid, Clearable, Scalar<String,Jid>, Reference

public class RootJid
extends ActorJid

The root Jid actor of a tree of Jid actors.

The serialized form of RootJid does NOT contain its length. The load method simply grabs all the remaining data.

Nested Class Summary

Nested classes/interfaces inherited from class org.agilewiki.jactor.lpc.JLPCActor

org.agilewiki.jactor.lpc.JLPCActor.SMBuilder

Field Summary

Fields inherited from class org.agilewiki.jid.scalar.vlens.VLenScalarJid

len, value

Fields inherited from class org.agilewiki.jid.Jid

serializedBytes, serializedOffset

Constructor Summary

Constructors

Constructor and Description
RootJid()

Method Summary

Methods

Modifier and Type	Method and Description
int	getSerializedLength() Returns the number of bytes needed to serialize the persistent data.
void	load(byte[] bytes) Assigns the serialized data to the RootJid.
int	load(byte[] bytes, int offset, int length) Load the serialized data into the RootJid.
protected int	loadLen(ReadableBytes readableBytes) Returns the size of the serialized data (exclusive of its length header).
int	save(byte[] bytes, int offset) Save the serialized data into a byte array.
protected void	saveLen(AppendableBytes appendableBytes) The length is not saved.
void	setContainerJid(_Jid containerJid) Throws an UnsupportedOperationException, as a RootJid does NOT have a container.
protected void	skipLen(ReadableBytes readableBytes) There is no length, so there is nothing to skip over.

Methods inherited from class org.agilewiki.jid.scalar.vlens.actor.ActorJid

clear, getValue, makeJidBytes, makeJidBytes, makeValue, makeValue, resolvePathname, serialize, setBytes, setBytes, setJidBytes, setJidBytes, setValue, setValue

Methods inherited from class org.agilewiki.jid.scalar.vlens.VLenScalarJid

change, load

Methods inherited from class org.agilewiki.jid.Jid

changed, copyJID, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, getSerializedBytes, isJidEqual, isSerialized, readable, save

Methods inherited from class org.agilewiki.jactor.lpc.JLPCActor

acceptEvent, acceptRequest, getActorType, getAncestor, getExceptionHandler, getFactory, getMailbox, getMailboxFactory, getMatch, getParent, hasDataItem, haveEvents, initialize, initialize, initialize, initialize, initialize, requirements, responseFrom, send, send, sendEvent, setExceptionHandler, setInitialBufferCapacity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.agilewiki.jid._Jid

change, load, save

Methods inherited from interface org.agilewiki.jactor.lpc.TargetActor

setExceptionHandler

Methods inherited from interface org.agilewiki.jactor.Actor

acceptEvent, acceptRequest, getActorType, getAncestor, getFactory, getMailbox, getMatch, getParent, hasDataItem, setInitialBufferCapacity

Constructor Detail

RootJid

public RootJid()

Method Detail

save

public int save(byte[] bytes,
       int offset)
         throws Exception

Save the serialized data into a byte array.

Parameters:

bytes - Where the serialized data is to be saved.

offset - Location of the serialized data.

Returns:

Updated offset.

Throws:

Exception

load

public int load(byte[] bytes,
       int offset,
       int length)
         throws Exception

Load the serialized data into the RootJid.

Parameters:

bytes - A mutable array holding the serialized data.

offset - Position of the serialized data.

length - Length of the serialized data

Returns:

The updated offset.

Throws:

Exception

load

public void load(byte[] bytes)
          throws Exception

Assigns the serialized data to the RootJid.

Parameters:

bytes - Holds the immutable serialized data. (And nothing else.)

Throws:

Exception

setContainerJid

public void setContainerJid(_Jid containerJid)

Throws an UnsupportedOperationException, as a RootJid does NOT have a container.

Specified by:

setContainerJid in interface _Jid

Overrides:

setContainerJid in class Jid

Parameters:

containerJid - The container, or null.

loadLen

protected int loadLen(ReadableBytes readableBytes)

Returns the size of the serialized data (exclusive of its length header).

Overrides:

loadLen in class VLenScalarJid<String,Jid>

Parameters:

readableBytes - Holds the serialized data.

Returns:

The size of the remaining bytes of serialized data.

skipLen

protected void skipLen(ReadableBytes readableBytes)

There is no length, so there is nothing to skip over.

Overrides:

skipLen in class VLenScalarJid<String,Jid>

Parameters:

readableBytes - Holds the serialized data.

saveLen

protected void saveLen(AppendableBytes appendableBytes)

The length is not saved.

Overrides:

saveLen in class VLenScalarJid<String,Jid>

Parameters:

appendableBytes - The object written to.

getSerializedLength

public int getSerializedLength()

Returns the number of bytes needed to serialize the persistent data.

Specified by:

getSerializedLength in interface _Jid

Overrides:

getSerializedLength in class VLenScalarJid<String,Jid>

Returns:

The minimum size of the byte array needed to serialize the persistent data.