org.agilewiki.jfile.block

Class LBlock

java.lang.Object

org.agilewiki.jfile.block.LBlock

All Implemented Interfaces:

Block

Direct Known Subclasses:

FBlock, LA32Block, LTBlock

public class LBlock
extends Object
implements Block

A block with a length in the header. --A minimal block implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	blockBytes
protected org.agilewiki.jid.ReadableBytes	rb
protected byte[]	rootJidBytes

Constructor Summary

Constructors

Constructor and Description
LBlock()

Method Summary

Methods

Modifier and Type	Method and Description
long	getCurrentPosition() Returns the file position.
String	getFileName() Returns the file name.
org.agilewiki.jid.scalar.vlens.actor.RootJid	getRootJid() Get an existing RootJid.
org.agilewiki.jid.scalar.vlens.actor.RootJid	getRootJid(org.agilewiki.jactor.Mailbox mailbox, org.agilewiki.jactor.Actor parent) Return the RootJid, deserializing it as needed..
long	getTimestamp() Returns the timestamp.
int	headerLength() The length of the header which prefaces the actual data on disk.
boolean	isEmpty() Indicates the abscense of a root jic.
protected void	saveHeader(org.agilewiki.jid.AppendableBytes ab, int l) Provides the raw header information to be written to disk.
byte[]	serialize() Serializes the header and the assigned RootJid.
void	setCurrentPosition(long position) Assigns the files current position.
void	setFileName(String fileName) Assigns the file's name.
int	setHeaderBytes(byte[] bytes) Provides the raw header information read from disk.
void	setRootJid(org.agilewiki.jid.scalar.vlens.actor.RootJid rootJid) Reset the block and assign the RootJid.
boolean	setRootJidBytes(byte[] rootJidBytes) Provides the data read from disk after the header.
void	setTimestamp(long timestamp) Assigns the timestamp.

Methods inherited from class java.lang.Object

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

Field Detail

rb

protected org.agilewiki.jid.ReadableBytes rb

blockBytes

protected byte[] blockBytes

rootJidBytes

protected byte[] rootJidBytes

Constructor Detail

LBlock

public LBlock()

Method Detail

setRootJid

public void setRootJid(org.agilewiki.jid.scalar.vlens.actor.RootJid rootJid)

Reset the block and assign the RootJid.

Specified by:

setRootJid in interface Block

Parameters:

rootJid - The RootJid to be assigned.

serialize

public byte[] serialize()
                 throws Exception

Serializes the header and the assigned RootJid.

Specified by:

serialize in interface Block

Returns:

The bytes of the header and serialized RootJid.

Throws:

Exception

saveHeader

protected void saveHeader(org.agilewiki.jid.AppendableBytes ab,
              int l)
                   throws Exception

Provides the raw header information to be written to disk.

Parameters:

ab - Append the data to this.

l - The length of the data.

Throws:

Exception

headerLength

public int headerLength()

The length of the header which prefaces the actual data on disk.

Specified by:

headerLength in interface Block

Returns:

The header length.

getFileName

public String getFileName()

Returns the file name.

Specified by:

getFileName in interface Block

Returns:

The file name.

setFileName

public void setFileName(String fileName)

Assigns the file's name.

Specified by:

setFileName in interface Block

getCurrentPosition

public long getCurrentPosition()

Returns the file position.

Specified by:

getCurrentPosition in interface Block

Returns:

The file position.

setCurrentPosition

public void setCurrentPosition(long position)

Assigns the files current position.

Specified by:

setCurrentPosition in interface Block

setHeaderBytes

public int setHeaderBytes(byte[] bytes)

Provides the raw header information read from disk.

Specified by:

setHeaderBytes in interface Block

Parameters:

bytes - The header bytes read from disk.

Returns:

The length of the data following the header on disk.

setRootJidBytes

public boolean setRootJidBytes(byte[] rootJidBytes)

Provides the data read from disk after the header.

Specified by:

setRootJidBytes in interface Block

Parameters:

rootJidBytes - The data following the header on disk.

Returns:

True when the data is valid.

getRootJid

public org.agilewiki.jid.scalar.vlens.actor.RootJid getRootJid()
                                                        throws Exception

Get an existing RootJid.

Specified by:

getRootJid in interface Block

Returns:

The RootJid.

Throws:

Exception - An exception is thrown when there is no RootJid.

getRootJid

public org.agilewiki.jid.scalar.vlens.actor.RootJid getRootJid(org.agilewiki.jactor.Mailbox mailbox,
                                                      org.agilewiki.jactor.Actor parent)
                                                        throws Exception

Return the RootJid, deserializing it as needed..

Specified by:

getRootJid in interface Block

Parameters:

mailbox - The mailbox.

parent - The parent.

Returns:

The deserialized RootJid, or null.

Throws:

Exception

isEmpty

public boolean isEmpty()

Indicates the abscense of a root jic.

Specified by:

isEmpty in interface Block

Returns:

True when a root jit is not present.

getTimestamp

public long getTimestamp()

Returns the timestamp.

Specified by:

getTimestamp in interface Block

Returns:

The timestamp.

setTimestamp

public void setTimestamp(long timestamp)

Assigns the timestamp.

Specified by:

setTimestamp in interface Block

Parameters:

timestamp - The timestamp.