net.sf.rej.util
Class ByteArrayByteParser

java.lang.Object
  net.sf.rej.util.ByteArrayByteParser

All Implemented Interfaces:

ByteParser

public class ByteArrayByteParser
extends java.lang.Object
implements ByteParser

Class that wraps a byte array and offers tools for reading the array.

Author:

Sami Koivu

Constructor Summary

ByteArrayByteParser(byte[] data)
Initializes this parser with the given byte array, starting the parsing from the beginning of the array.

ByteArrayByteParser(byte[] data, int pos)
Initializes this parse with the given byte array, starting the parsing from the position indicated by the parameter pos.

Method Summary

byte	getByte() Returns the next byte available.
int	getByteAsInt() Returns the next unsigned byte available as an int.
byte[]	getBytes(int count) Returns an array of the next count bytes.
long	getInt() Returns the unsigned value of the next 4 bytes as a long.
ByteParser	getNewParser() Deprecated.
int	getPosition() Returns the current position of this parser.
int	getShortAsInt() Returns the unsigned value of the next two bytes available in the parser as an int.
boolean	hasMore() Returns true if the end of the underlying data source has not been reached yet.
int	peekByte() Returns an unsigned value of the next byte in this parser, without advancing the position of the parser.
void	setBigEndian(boolean bigEndian) Sets the big-endian mode of this parser.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayByteParser

public ByteArrayByteParser(byte[] data)

Initializes this parser with the given byte array, starting the parsing from the beginning of the array.

Parameters:

data - a byte array to parse.

ByteArrayByteParser

public ByteArrayByteParser(byte[] data,
                           int pos)

Initializes this parse with the given byte array, starting the parsing from the position indicated by the parameter pos.

Parameters:

data - a byte array to parse.

pos - the position to start parsing from.

Method Detail

getByte

public byte getByte()

Description copied from interface: ByteParser

Returns the next byte available.

Specified by:

getByte in interface ByteParser

Returns:

next byte in the parser.

getBytes

public byte[] getBytes(int count)

Description copied from interface: ByteParser

Returns an array of the next count bytes.

Specified by:

getBytes in interface ByteParser

Parameters:

count - the number of bytes to read.

Returns:

a byte array of the data read.

getByteAsInt

public int getByteAsInt()

Description copied from interface: ByteParser

Returns the next unsigned byte available as an int.

Specified by:

getByteAsInt in interface ByteParser

Returns:

the unsigned value of the next available byte.

getShortAsInt

public int getShortAsInt()

Description copied from interface: ByteParser

Returns the unsigned value of the next two bytes available in the parser as an int.

Specified by:

getShortAsInt in interface ByteParser

Returns:

the next available unsigned short value.

getInt

public long getInt()

Description copied from interface: ByteParser

Returns the unsigned value of the next 4 bytes as a long.

Specified by:

getInt in interface ByteParser

Returns:

long value of the next 4 bytes.

getNewParser

@Deprecated
public ByteParser getNewParser()

Deprecated.

Description copied from interface: ByteParser

Creates a new parser starting from the current position independent of this parser.

Specified by:

getNewParser in interface ByteParser

Returns:

a new parser starting from current position.

setBigEndian

public void setBigEndian(boolean bigEndian)

Description copied from interface: ByteParser

Sets the big-endian mode of this parser.

Specified by:

setBigEndian in interface ByteParser

Parameters:

bigEndian - a boolean value true for big-endian mode, false for non-big-endian mode.

hasMore

public boolean hasMore()

Description copied from interface: ByteParser

Returns true if the end of the underlying data source has not been reached yet. Not that the return of this method in no way indicates that data is available for immediate reading, for example of the underlying data source is a socket.

Specified by:

hasMore in interface ByteParser

Returns:

boolean true if there is still more data available to be read.

getPosition

public int getPosition()

Description copied from interface: ByteParser

Returns the current position of this parser. In other words, the number of bytes read from this parser.

Specified by:

getPosition in interface ByteParser

Returns:

the position of this parser.

peekByte

public int peekByte()

Description copied from interface: ByteParser

Returns an unsigned value of the next byte in this parser, without advancing the position of the parser. Thus, if this method is called n times in succession without calling the other methods of this class, a value i will be consistently returned every time. This method is identical to the method ByteParser.getByteAsInt() other than for the fact that the position is not advanced.

Specified by:

peekByte in interface ByteParser

Returns:

the unsigned value of the next available byte.