abs.ixi.client.lang

Class ByteSource

java.lang.Object

abs.ixi.client.lang.ByteSource

All Implemented Interfaces:

Resetable

public class ByteSource
extends Object
implements Resetable

ByteSource is a wrapper around byte array. It maintains vital fields such as position, limit and capacity to facilitate better reading process.

ByteSource is unidirectional (can be read only in one direction); however it offers random access using index.

position is is the index of first byte which will be read. limit is the index of first byte which will not be read.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ByteSource.ByteRange Range captures a byte range with a start index and an end index.

Constructor Summary

Constructors

Constructor and Description
ByteSource(byte[] bytes)
ByteSource(byte[] bytes, int position, int limit)

Method Summary

Modifier and Type	Method and Description
byte[]	bytes()
int	capacity()
void	get(byte[] src) Copies remaining byte data of this ByteSource into the src byte array.
void	get(byte[] src, int srcPos) Copies remaining byte data of this ByteSource into the src byte starting from the srcPos.
void	get(byte[] src, int srcPos, int length) Copies bytes data of this ByteSource into the src byte starting from the srcPos.
byte	get(int index) Returns the byte at the index.
int	getPosition()
boolean	hasNext() Returns true if there is another byte which can be read from this ByteSource
int	limit() Returns limit of this byte source.
byte	next() Reads next byte from data source; after reading the byte, position moves to next byte.
int	position()
void	reload(byte[] bytes) Reloads this ByteSource with given bytes.
void	reload(byte[] bytes, int position) Reloads this ByteSource with given bytes.
void	reload(byte[] bytes, int position, int limit) Reloads this ByteSource with given bytes
int	remaining() Number of chars remainig in this ByteSource.
void	reset(boolean full) Flushes out data, repositions counters and markers held by this object
void	setPosition(int position) Sets position index to the given value

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteSource

public ByteSource(byte[] bytes)

ByteSource

public ByteSource(byte[] bytes,
                  int position,
                  int limit)

Method Detail

bytes

public byte[] bytes()

position

public int position()

limit

public int limit()

Returns limit of this byte source. Important to note that limit is an index; not an absolute number.

Returns:

int int

capacity

public int capacity()

getPosition

public int getPosition()

next

public byte next()

Reads next byte from data source; after reading the byte, position moves to next byte.

Returns:

byte byte

hasNext

public final boolean hasNext()

Returns true if there is another byte which can be read from this ByteSource

Returns:

boolean true or false

get

public byte get(int index)

Returns the byte at the index. The method does not change any marker such as limit, position etc.

Parameters:

index - index of the byte

Returns:

byte byte

get

public void get(byte[] src)

Copies remaining byte data of this ByteSource into the src byte array. If the length of src array is smaller than the remaining content, the method will throw ArrayIndexOutOfBoundsException

Parameters:

src - src

get

public void get(byte[] src,
                int srcPos)

Copies remaining byte data of this ByteSource into the src byte starting from the srcPos. If the length of src array is smaller than the remaining content, the method will throw ArrayIndexOutOfBoundsException

Parameters:

src - src

srcPos - srcPos

get

public void get(byte[] src,
                int srcPos,
                int length)

Copies bytes data of this ByteSource into the src byte starting from the srcPos. If the length of src array is smaller than the remaining content, the method will throw ArrayIndexOutOfBoundsException

Parameters:

src - src

srcPos - srcPos

length - length

reset

public void reset(boolean full)

Description copied from interface: Resetable

Flushes out data, repositions counters and markers held by this object

Specified by:

reset in interface Resetable

Parameters:

full - true oe false

reload

public void reload(byte[] bytes)

Reloads this ByteSource with given bytes. The position of the byte source will be set to zero and limit will be set to the length of the byte array.

Parameters:

bytes - bytes array (data)

reload

public void reload(byte[] bytes,
                   int position)

Reloads this ByteSource with given bytes. The position of the byte source will be set to the position supplied and limit will be set to the length of the byte array.

Parameters:

bytes - bytes array (data)

position - position from which reading will start

reload

public void reload(byte[] bytes,
                   int position,
                   int limit)

Reloads this ByteSource with given bytes

Parameters:

bytes - bytes array (data)

position - position from which reading will start

limit - boundary index. The reading cursor will always be behind the boundary

setPosition

public void setPosition(int position)

Sets position index to the given value

Parameters:

position - position

remaining

public int remaining()

Number of chars remainig in this ByteSource. The number is position variables; although at any point underlying array has all the elements.

Returns:

int int