org.qbroker.common

Class DelimitedBuffer

java.lang.Object

org.qbroker.common.DelimitedBuffer

public class DelimitedBuffer
extends java.lang.Object

DelimitedBuffer is a byte buffer for parsing delimited content. The delimiter can be defined at the beginning as SOT and/or at the end as EOT. However, EOT and SOT should never share any byte chars.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	MS_EOT
static int	MS_SOT

Constructor Summary

Constructors

Constructor and Description
DelimitedBuffer(int size, int offhead, byte[] sot, int offtail, byte[] eot)
DelimitedBuffer(int size, int offhead, java.lang.String sot, int offtail, java.lang.String eot)

Method Summary

Modifier and Type	Method and Description
int	getBoundary()
byte[]	getBuffer()
byte[]	getEotBytes()
int	getLeftover()
int	getOffhead()
int	getOfftail()
byte[]	getSotBytes()
void	reset()
int	scan(int offset, int length) It scans the byte array of the internal buffer for either EOT or SOT strings starting from offset up to its end defined by length.
void	setLeftover(int i)

Methods inherited from class java.lang.Object

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

Field Detail

MS_SOT

public static final int MS_SOT

See Also:

Constant Field Values

MS_EOT

public static final int MS_EOT

See Also:

Constant Field Values

Constructor Detail

DelimitedBuffer

public DelimitedBuffer(int size,
                       int offhead,
                       java.lang.String sot,
                       int offtail,
                       java.lang.String eot)

Parameters:

size - the buffer size

offhead - number of bytes to trim off the delimiter at the beginning

sot - a hexString of the delimiter at the beginning

offtail - number of bytes to trim off the delimiter at the end

eot - a hexString of the delimiter at the end

DelimitedBuffer

public DelimitedBuffer(int size,
                       int offhead,
                       byte[] sot,
                       int offtail,
                       byte[] eot)

Method Detail

scan

public int scan(int offset,
                int length)

It scans the byte array of the internal buffer for either EOT or SOT strings starting from offset up to its end defined by length. It returns the position immediately after the string. If position is larger than 0, it is end of SOT. If position is less than 0, it is end of EOT. Otherwise, it returns 0, nothing found.

It is ok not to define SOT and/or EOT. However, EOT and SOT must never share any same byte (no overlap) This method is NOT MT-Safe since it requires the global objects: sotPosition, eotPosition, buffer.

getBuffer

public byte[] getBuffer()

getSotBytes

public byte[] getSotBytes()

getEotBytes

public byte[] getEotBytes()

getOfftail

public int getOfftail()

getOffhead

public int getOffhead()

getBoundary

public int getBoundary()

getLeftover

public int getLeftover()

setLeftover

public void setLeftover(int i)

reset

public void reset()