Package io.kaitai.struct

Class RandomAccessFileKaitaiStream

java.lang.Object

io.kaitai.struct.KaitaiStream

io.kaitai.struct.RandomAccessFileKaitaiStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class RandomAccessFileKaitaiStream
extends KaitaiStream

An implementation of KaitaiStream backed by a RandomAccessFile. Allows reading from local files. Generally, one would want to use ByteBufferKaitaiStream instead, as it most likely would be faster, but there are two situations when one should consider this one instead:

• Processing many small files. Every ByteBuffer invocation requires a mmap call, which can be relatively expensive (per file).
• Accessing extra-long files (>31 bits positioning). Unfortunately, Java's implementation of mmap uses ByteBuffer, which is not addressable beyond 31 bit offsets, even if you use a 64-bit platform.

Nested Class Summary

Nested classes/interfaces inherited from class io.kaitai.struct.KaitaiStream

KaitaiStream.KaitaiStructError, KaitaiStream.UndecidedEndiannessError, KaitaiStream.UnexpectedDataError, KaitaiStream.ValidationExprError, KaitaiStream.ValidationFailedError, KaitaiStream.ValidationGreaterThanError, KaitaiStream.ValidationLessThanError, KaitaiStream.ValidationNotAnyOfError, KaitaiStream.ValidationNotEqualError, KaitaiStream.WriteBackHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected RandomAccessFile	raf

Fields inherited from class io.kaitai.struct.KaitaiStream

bits, bitsLe, bitsLeft, bitsWriteMode, childStreams, writeBackHandler

Constructor Summary

Constructors

Constructor	Description
RandomAccessFileKaitaiStream(RandomAccessFile raf)
RandomAccessFileKaitaiStream(String fileName)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	ensureBytesLeftToWrite(long n)
boolean	isEof()	Check if stream pointer is at the end of stream.
int	pos()	Get current position of a stream pointer.
byte[]	readBytesFull()	Reads all the remaining bytes in a stream as byte array.
protected byte[]	readBytesNotAligned(long n)	Internal method to read the specified number of bytes from the stream.
byte[]	readBytesTerm(byte term, boolean includeTerm, boolean consumeTerm, boolean eosError)
float	readF4be()
float	readF4le()
double	readF8be()
double	readF8le()
byte	readS1()	Reads one signed 1-byte integer, returning it properly as Java's "byte" type.
short	readS2be()
short	readS2le()
int	readS4be()
int	readS4le()
long	readS8be()
long	readS8le()
int	readU1()
int	readU2be()
int	readU2le()
long	readU4be()
long	readU4le()
void	seek(int newPos)	Set stream pointer to designated position (int).
void	seek(long newPos)	Set stream pointer to designated position (long).
long	size()	Get total size of the stream in bytes.
KaitaiStream	substream(long n)	Reserves next `n` bytes from current stream as a KaitaiStream-compatible substream.
protected void	writeBytesNotAligned(byte[] buf)	Internal method to write the given byte array to the stream.
void	writeF4be(float v)
void	writeF4le(float v)
void	writeF8be(double v)
void	writeF8le(double v)
void	writeS1(byte v)	Writes one signed 1-byte integer.
void	writeS2be(short v)
void	writeS2le(short v)
void	writeS4be(int v)
void	writeS4le(int v)
void	writeS8be(long v)
void	writeS8le(long v)

Methods inherited from class io.kaitai.struct.KaitaiStream

addChildStream, alignToByte, byteArrayCompare, byteArrayIndexOf, byteArrayMax, byteArrayMin, bytesStripRight, bytesTerminate, ensureBytesLeftToWrite, ensureFixedContents, mod, mod, processRotateLeft, processXor, processXor, processZlib, readBitsInt, readBitsIntBe, readBitsIntLe, readBytes, readU8be, readU8le, setWriteBackHandler, toByteArray, toByteArrayLength, unprocessZlib, writeAlignToByte, writeBack, writeBackChildStreams, writeBackChildStreams, writeBitsIntBe, writeBitsIntLe, writeBytes, writeBytesLimit, writeStream, writeU1, writeU2be, writeU2le, writeU4be, writeU4le, writeU8be, writeU8le

Methods inherited from class java.lang.Object

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

Field Detail

raf

protected RandomAccessFile raf

Constructor Detail

RandomAccessFileKaitaiStream

public RandomAccessFileKaitaiStream(String fileName)
                             throws IOException

Throws:

IOException

RandomAccessFileKaitaiStream

public RandomAccessFileKaitaiStream(RandomAccessFile raf)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class KaitaiStream

Throws:

IOException

isEof

public boolean isEof()

Description copied from class: KaitaiStream

Check if stream pointer is at the end of stream.

Specified by:

isEof in class KaitaiStream

Returns:

true if we are located at the end of the stream

seek

public void seek(int newPos)

Description copied from class: KaitaiStream

Set stream pointer to designated position (int).

Specified by:

seek in class KaitaiStream

Parameters:

newPos - new position (offset in bytes from the beginning of the stream)

seek

public void seek(long newPos)

Description copied from class: KaitaiStream

Set stream pointer to designated position (long).

Specified by:

seek in class KaitaiStream

Parameters:

newPos - new position (offset in bytes from the beginning of the stream)

pos

public int pos()

Description copied from class: KaitaiStream

Get current position of a stream pointer.

Specified by:

pos in class KaitaiStream

Returns:

pointer position, number of bytes from the beginning of the stream

size

public long size()

Description copied from class: KaitaiStream

Get total size of the stream in bytes.

Specified by:

size in class KaitaiStream

Returns:

size of the stream in bytes

readS1

public byte readS1()

Description copied from class: KaitaiStream

Reads one signed 1-byte integer, returning it properly as Java's "byte" type.

Specified by:

readS1 in class KaitaiStream

Returns:

1-byte integer read from a stream

readS2be

public short readS2be()

Specified by:

readS2be in class KaitaiStream

readS4be

public int readS4be()

Specified by:

readS4be in class KaitaiStream

readS8be

public long readS8be()

Specified by:

readS8be in class KaitaiStream

readS2le

public short readS2le()

Specified by:

readS2le in class KaitaiStream

readS4le

public int readS4le()

Specified by:

readS4le in class KaitaiStream

readS8le

public long readS8le()

Specified by:

readS8le in class KaitaiStream

readU1

public int readU1()

Specified by:

readU1 in class KaitaiStream

readU2be

public int readU2be()

Specified by:

readU2be in class KaitaiStream

readU4be

public long readU4be()

Specified by:

readU4be in class KaitaiStream

readU2le

public int readU2le()

Specified by:

readU2le in class KaitaiStream

readU4le

public long readU4le()

Specified by:

readU4le in class KaitaiStream

readF4be

public float readF4be()

Specified by:

readF4be in class KaitaiStream

readF8be

public double readF8be()

Specified by:

readF8be in class KaitaiStream

readF4le

public float readF4le()

Specified by:

readF4le in class KaitaiStream

readF8le

public double readF8le()

Specified by:

readF8le in class KaitaiStream

readBytesNotAligned

protected byte[] readBytesNotAligned(long n)

Description copied from class: KaitaiStream

Internal method to read the specified number of bytes from the stream. Unlike KaitaiStream.readBytes(long), it doesn't align the bit position to the next byte boundary.

Specified by:

readBytesNotAligned in class KaitaiStream

Parameters:

n - number of bytes to read

Returns:

read bytes as a byte array

readBytesFull

public byte[] readBytesFull()

Description copied from class: KaitaiStream

Reads all the remaining bytes in a stream as byte array.

Specified by:

readBytesFull in class KaitaiStream

Returns:

all remaining bytes in a stream as byte array

readBytesTerm

public byte[] readBytesTerm(byte term,
                            boolean includeTerm,
                            boolean consumeTerm,
                            boolean eosError)

Specified by:

readBytesTerm in class KaitaiStream

substream

public KaitaiStream substream(long n)

Description copied from class: KaitaiStream

Reserves next `n` bytes from current stream as a KaitaiStream-compatible substream. Substream has its own pointer and addressing in the range of [0, n) bytes. This stream's pointer is advanced to the position right after this substream.

Specified by:

substream in class KaitaiStream

Parameters:

n - number of bytes to reserve for a substream

Returns:

substream covering n bytes from the current position

ensureBytesLeftToWrite

protected void ensureBytesLeftToWrite(long n)
                               throws IOException

Throws:

IOException

writeS1

public void writeS1(byte v)

Writes one signed 1-byte integer.

Specified by:

writeS1 in class KaitaiStream

writeS2be

public void writeS2be(short v)

Specified by:

writeS2be in class KaitaiStream

writeS4be

public void writeS4be(int v)

Specified by:

writeS4be in class KaitaiStream

writeS8be

public void writeS8be(long v)

Specified by:

writeS8be in class KaitaiStream

writeS2le

public void writeS2le(short v)

Specified by:

writeS2le in class KaitaiStream

writeS4le

public void writeS4le(int v)

Specified by:

writeS4le in class KaitaiStream

writeS8le

public void writeS8le(long v)

Specified by:

writeS8le in class KaitaiStream

writeF4be

public void writeF4be(float v)

Specified by:

writeF4be in class KaitaiStream

writeF8be

public void writeF8be(double v)

Specified by:

writeF8be in class KaitaiStream

writeF4le

public void writeF4le(float v)

Specified by:

writeF4le in class KaitaiStream

writeF8le

public void writeF8le(double v)

Specified by:

writeF8le in class KaitaiStream

writeBytesNotAligned

protected void writeBytesNotAligned(byte[] buf)

Description copied from class: KaitaiStream

Internal method to write the given byte array to the stream. Unlike KaitaiStream.writeBytes(byte[]), it doesn't align the bit position to the next byte boundary.

Specified by:

writeBytesNotAligned in class KaitaiStream

Parameters:

buf - byte array to write