org.freecompany.redline.header

Class AbstractHeader

public abstract class AbstractHeader extends Object

Nested Class Summary
abstract class	AbstractHeader.AbstractEntry<T>
interface	AbstractHeader.Entry<T>
interface	AbstractHeader.Tag

Field Summary
protected Map<Integer,Entry<?>>	entries
protected static int	ENTRY_SIZE
protected static int	HEADER_HEADER_SIZE
protected static int	MAGIC_WORD
protected Map<Entry<?>,Integer>	pending
protected Map<Integer,AbstractHeader.Tag>	tags

Method Summary
int	count()
Entry<?>	createEntry(int tag, int type, int count)
protected Entry<?>	createEntry(int type)
protected ByteBuffer	getData(ByteBuffer index) Writes the data section of the file, starting at the current position which must be immediately after the header section.
Entry<?>	getEntry(AbstractHeader.Tag tag)
Entry<?>	getEntry(int tag)
protected ByteBuffer	getHeader() Memory maps the portion of the destination file that will contain the header structure header and advances the file channels position.
protected ByteBuffer	getIndex() Memory maps the portion of the destination file that will contain the index structure header and advances the file channels position.
Map<Entry<?>,Integer>	getPending()
protected abstract boolean	pad()
int	read(ReadableByteChannel in) Reads the entire header contents for this channel and returns the number of entries found.
Entry<?>	readEntry(int tag, int type, int offset, int count, ByteBuffer data)
void	removeEntry(Entry<?> entry)
String	toString()
int	write(WritableByteChannel out) Writes this header section to the provided file at the current position and returns the required padding.
protected int	writeData(Collection<ByteBuffer> buffers, ByteBuffer index, Entry<?> entry, int offset)

Field Detail

entries

protected final Map<Integer,Entry<?>> entries

HEADER_HEADER_SIZE

protected static final int HEADER_HEADER_SIZE

pending

protected final Map<Entry<?>,Integer> pending

Method Detail

createEntry

public Entry<?> createEntry(int tag, int type, int count)

createEntry

protected Entry<?> createEntry(int type)

getData

protected ByteBuffer getData(ByteBuffer index)

Writes the data section of the file, starting at the current position which must be immediately after the header section. Each entry writes its corresponding index into the provided index buffer and then writes its data to the file channel.

Returns: the total number of bytes written to the data section of the file.

getEntry

public Entry<?> getEntry(AbstractHeader.Tag tag)

getEntry

public Entry<?> getEntry(int tag)

getHeader

protected ByteBuffer getHeader()

Memory maps the portion of the destination file that will contain the header structure header and advances the file channels position. The resulting buffer will be prefilled with the necesssary magic data and the correct index count, but will require an integer value to be written with the total data section size once data writing is complete.

This method must be invoked before mapping the index or data sections.

getIndex

protected ByteBuffer getIndex()

Memory maps the portion of the destination file that will contain the index structure header and advances the file channels position. The resulting buffer will be ready for writing of the entry indexes.

This method must be invoked before mapping the data section, but after mapping the header.