org.agilewiki.jid.scalar.vlens

Class VLenScalarJid<SET_TYPE,RESPONSE_TYPE>

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<SET_TYPE,RESPONSE_TYPE>

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<SET_TYPE,RESPONSE_TYPE>

Direct Known Subclasses:

ActorJid, BytesJid, StringJid

public abstract class VLenScalarJid<SET_TYPE,RESPONSE_TYPE>
extends ScalarJid<SET_TYPE,RESPONSE_TYPE>
implements Clearable

A JID component that holds a variable-length value, or null.

Nested Class Summary

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

org.agilewiki.jactor.lpc.JLPCActor.SMBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected int	len The size of the serialized (exclusive of its length header).
protected RESPONSE_TYPE	value Holds the value, or null.

Fields inherited from class org.agilewiki.jid.Jid

serializedBytes, serializedOffset

Constructor Summary

Constructors

Constructor and Description
VLenScalarJid()

Method Summary

Methods

Modifier and Type	Method and Description
void	change(int lengthChange) Process a change in the persistent data.
void	clear() Clear the content.
int	getSerializedLength() Returns the number of bytes needed to serialize the persistent data.
void	load(ReadableBytes readableBytes) Assigns the serialized data to the JID.
protected int	loadLen(ReadableBytes readableBytes) Returns the size of the serialized data (exclusive of its length header).
protected abstract Boolean	makeValue(SET_TYPE v) Assign a value unless one is already present.
protected void	saveLen(AppendableBytes appendableBytes) Writes the size of the serialized data (exclusive of its length header).
protected void	skipLen(ReadableBytes readableBytes) Skip over the length at the beginning of the serialized data.

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, resolvePathname, save, serialize, setContainerJid

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

resolvePathname, save, setContainerJid

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

Methods inherited from interface org.agilewiki.jid.scalar.Scalar

getValue, setValue

Field Detail

value

protected RESPONSE_TYPE value

Holds the value, or null.

len

protected int len

The size of the serialized (exclusive of its length header).

Constructor Detail

VLenScalarJid

public VLenScalarJid()

Method Detail

makeValue

protected abstract Boolean makeValue(SET_TYPE v)
                              throws Exception

Assign a value unless one is already present.

Parameters:

v - The value.

Returns:

True if a new value is created.

Throws:

Exception - Any uncaught exception raised.

clear

public void clear()
           throws Exception

Clear the content.

Specified by:

clear in interface Clearable

Throws:

Exception - Any uncaught exception raised.

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 Jid

Returns:

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

loadLen

protected int loadLen(ReadableBytes readableBytes)

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

Parameters:

readableBytes - Holds the serialized data.

Returns:

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

saveLen

protected void saveLen(AppendableBytes appendableBytes)

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

Parameters:

appendableBytes - The object written to.

skipLen

protected void skipLen(ReadableBytes readableBytes)

Skip over the length at the beginning of the serialized data.

Parameters:

readableBytes - Holds the serialized data.

change

public void change(int lengthChange)
            throws Exception

Process a change in the persistent data.

Specified by:

change in interface _Jid

Overrides:

change in class Jid

Parameters:

lengthChange - The change in the size of the serialized data.

Throws:

Exception - Any uncaught exception which occurred while processing the change.

load

public void load(ReadableBytes readableBytes)
          throws Exception

Assigns the serialized data to the JID.

Specified by:

load in interface _Jid

Overrides:

load in class Jid

Parameters:

readableBytes - Holds the immutable serialized data.

Throws:

Exception