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

Field Summary

Fields
Modifier and Type Field Description

protected RandomAccessFile raf
- Fields inherited from class io.kaitai.struct.KaitaiStream
  bits, bitsLeft

Constructor Summary

Constructors
Constructor Description

RandomAccessFileKaitaiStream(String fileName)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`boolean`	`isEof()`	Check if stream pointer is at the end of stream.
`int`	`pos()`	Get current position of a stream pointer.
`byte[]`	`readBytes(long n)`	Reads designated number of bytes from the stream.
`byte[]`	`readBytesFull()`	Reads all the remaining bytes in a stream as byte array.
`byte[]`	`readBytesTerm(int 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.

Methods inherited from class io.kaitai.struct.KaitaiStream
alignToByte, byteArrayCompare, byteArrayMax, byteArrayMin, bytesStripRight, bytesTerminate, ensureFixedContents, mod, mod, processRotateLeft, processXor, processXor, processZlib, readBitsInt, readBitsIntBe, readBitsIntLe, readU8be, readU8le, toByteArrayLength

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
- 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
  - readBytes
```
public byte[] readBytes(long n)
```
    Description copied from class: KaitaiStream
    
    Reads designated number of bytes from the stream.
    
    Specified by:
    
    readBytes in class KaitaiStream
    
    Parameters:
    
    n - number of bytes to read
    
    Returns:
    
    read bytes as 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(int term,
                            boolean includeTerm,
                            boolean consumeTerm,
                            boolean eosError)
```
    Specified by:
    
    readBytesTerm in class KaitaiStream

Class RandomAccessFileKaitaiStream

Nested Class Summary

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

Field Summary

Fields inherited from class io.kaitai.struct.KaitaiStream

Constructor Summary

Method Summary

Methods inherited from class io.kaitai.struct.KaitaiStream

Methods inherited from class java.lang.Object

Field Detail

raf

Constructor Detail

RandomAccessFileKaitaiStream

Method Detail

close

isEof

seek

seek

pos

size

readS1

readS2be

readS4be

readS8be

readS2le

readS4le

readS8le

readU1

readU2be

readU4be

readU2le

readU4le

readF4be

readF8be

readF4le

readF8le

readBytes

readBytesFull

readBytesTerm