Package mil.nga.tiff.io

Class ByteReader

java.lang.Object

mil.nga.tiff.io.ByteReader

public class ByteReader
extends Object

Read through a byte array

Author:

osbornb

Constructor Summary

Constructors

Constructor	Description
ByteReader(byte[] bytes)	Constructor
ByteReader(byte[] bytes, ByteOrder byteOrder)	Constructor

Method Summary

Modifier and Type	Method	Description
int	byteLength()	Get the byte length
ByteOrder	getByteOrder()	Get the byte order
int	getNextByte()	Get the next byte to be read
boolean	hasByte()	Check if there is at least one more byte left to read
boolean	hasByte(int offset)	Check if there is at least one more byte left to read
boolean	hasBytes(int count)	Check if there are the provided number of bytes left to read
boolean	hasBytes(int offset, int count)	Check if there are the provided number of bytes left to read
byte	readByte()	Read a byte
byte	readByte(int offset)	Read a byte
byte[]	readBytes(int num)	Read a number of bytes
byte[]	readBytes(int offset, int num)	Read a number of bytes
double	readDouble()	Read a double
double	readDouble(int offset)	Read a double
float	readFloat()	Read a float
float	readFloat(int offset)	Read a float
int	readInt()	Read an integer
int	readInt(int offset)	Read an integer
short	readShort()	Read a short
short	readShort(int offset)	Read a short
String	readString(int num)	Read a String from the provided number of bytes
String	readString(int offset, int num)	Read a String from the provided number of bytes
short	readUnsignedByte()	Read an unsigned byte
short	readUnsignedByte(int offset)	Read an unsigned byte
long	readUnsignedInt()	Read an unsigned int
long	readUnsignedInt(int offset)	Read an unsigned int
int	readUnsignedShort()	Read an unsigned short
int	readUnsignedShort(int offset)	Read an unsigned short
void	setByteOrder(ByteOrder byteOrder)	Set the byte order
void	setNextByte(long nextByte)	Set the next byte to be read

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteReader

public ByteReader(byte[] bytes)

Constructor

Parameters:

bytes - bytes

ByteReader

public ByteReader(byte[] bytes,
                  ByteOrder byteOrder)

Constructor

Parameters:

bytes - bytes

byteOrder - byte order

Method Detail

getNextByte

public int getNextByte()

Get the next byte to be read

Returns:

next byte to be read

setNextByte

public void setNextByte(long nextByte)

Set the next byte to be read

Parameters:

nextByte - next byte

getByteOrder

public ByteOrder getByteOrder()

Get the byte order

Returns:

byte order

setByteOrder

public void setByteOrder(ByteOrder byteOrder)

Set the byte order

Parameters:

byteOrder - byte order

hasByte

public boolean hasByte()

Check if there is at least one more byte left to read

Returns:

true more bytes left to read

hasByte

public boolean hasByte(int offset)

Check if there is at least one more byte left to read

Parameters:

offset - byte offset

Returns:

true more bytes left to read

hasBytes

public boolean hasBytes(int count)

Check if there are the provided number of bytes left to read

Parameters:

count - number of bytes

Returns:

true if has at least the number of bytes left

hasBytes

public boolean hasBytes(int offset,
                        int count)

Check if there are the provided number of bytes left to read

Parameters:

offset - byte offset

count - number of bytes

Returns:

true if has at least the number of bytes left

readString

public String readString(int num)
                  throws UnsupportedEncodingException

Read a String from the provided number of bytes

Parameters:

num - number of bytes

Returns:

String

Throws:

UnsupportedEncodingException - upon string encoding error

readString

public String readString(int offset,
                         int num)
                  throws UnsupportedEncodingException

Read a String from the provided number of bytes

Parameters:

offset - byte offset

num - number of bytes

Returns:

String

Throws:

UnsupportedEncodingException - upon string encoding error

readByte

public byte readByte()

Read a byte

Returns:

byte

readByte

public byte readByte(int offset)

Read a byte

Parameters:

offset - byte offset

Returns:

byte

readUnsignedByte

public short readUnsignedByte()

Read an unsigned byte

Returns:

unsigned byte as short

readUnsignedByte

public short readUnsignedByte(int offset)

Read an unsigned byte

Parameters:

offset - byte offset

Returns:

unsigned byte as short

readBytes

public byte[] readBytes(int num)

Read a number of bytes

Parameters:

num - number of bytes

Returns:

bytes

readBytes

public byte[] readBytes(int offset,
                        int num)

Read a number of bytes

Parameters:

offset - byte offset

num - number of bytes

Returns:

bytes

readShort

public short readShort()

Read a short

Returns:

short

readShort

public short readShort(int offset)

Read a short

Parameters:

offset - byte offset

Returns:

short

readUnsignedShort

public int readUnsignedShort()

Read an unsigned short

Returns:

unsigned short as int

readUnsignedShort

public int readUnsignedShort(int offset)

Read an unsigned short

Parameters:

offset - byte offset

Returns:

unsigned short as int

readInt

public int readInt()

Read an integer

Returns:

integer

readInt

public int readInt(int offset)

Read an integer

Parameters:

offset - byte offset

Returns:

integer

readUnsignedInt

public long readUnsignedInt()

Read an unsigned int

Returns:

unsigned int as long

readUnsignedInt

public long readUnsignedInt(int offset)

Read an unsigned int

Parameters:

offset - byte offset

Returns:

unsigned int as long

readFloat

public float readFloat()

Read a float

Returns:

float

readFloat

public float readFloat(int offset)

Read a float

Parameters:

offset - byte offset

Returns:

float

readDouble

public double readDouble()

Read a double

Returns:

double

readDouble

public double readDouble(int offset)

Read a double

Parameters:

offset - byte offset

Returns:

double

byteLength

public int byteLength()

Get the byte length

Returns:

byte length