BinaryReader

java.lang.Object
- org.apache.nifi.processors.evtx.parser.BinaryReader

```
public class BinaryReader
extends java.lang.Object
```
Class to simplify reading binary values from the evtx file

Field Summary

Fields
Modifier and Type Field and Description

static long EPOCH_OFFSET

static int[][] INDEX_ARRAYS

Fields
Modifier and Type	Field and Description
`static long`	`EPOCH_OFFSET`
`static int[][]`	`INDEX_ARRAYS`

Constructor Summary

Constructors
Constructor and Description
`BinaryReader(BinaryReader binaryReader, int position)` Constructs a binary reader with the given one's byte array and an arbitrary position
`BinaryReader(byte[] bytes)` Creates a BinaryReader for the given bytes
`BinaryReader(java.io.InputStream inputStream, int size)` Reads size bytes from the inputStream and creates a BinaryReader for them

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getBytes()` Returns the backing byte array
`int`	`getPosition()` Returns the current position of the BinaryReader
`int`	`peek()` Returns the byte that would be read without changing the position
`byte[]`	`peekBytes(int length)` Returns the next length bytes without changing the position
`int`	`read()` Reads a single byte
`java.lang.String`	`readAndBase64EncodeBinary(int length)` Reads length bytes and Bas64 encodes them
`void`	`readBytes(byte[] buf, int offset, int length)` Reads the next length bytes into the buf buffer at a given offset
`byte[]`	`readBytes(int length)` Reads the next length bytes
`com.google.common.primitives.UnsignedInteger`	`readDWord()` Reads 4 bytes in little endian order and returns the UnsignedInteger value
`com.google.common.primitives.UnsignedInteger`	`readDWordBE()` Reads 4 bytes in big endian order and returns the UnsignedInteger value
`java.util.Date`	`readFileTime()` Reads a timestamp that is the number of hundreds of nanoseconds since Jan 1 1601 (see http://integriography.wordpress.com/2010/01/16/using-phython-to-parse-and-present-windows-64-bit-timestamps/)
`java.lang.String`	`readGuid()` Reads an Evtx formatted guid (16 bytes arranged into the grouping described by INDEX_ARRAYS)
`com.google.common.primitives.UnsignedLong`	`readQWord()` Reads 8 bytes in litte endian order and returns the UnsignedLong value
`java.lang.String`	`readString(int length)` Reads a string made up of single byte characters
`int`	`readWord()` Reads 2 bytes in little endian order and returns the int value
`int`	`readWordBE()` Reads 2 bytes in big endian order and returns the int value
`java.lang.String`	`readWString(int length)` Reads a string encoded with UTF_16LE of a given length
`void`	`skip(int bytes)` Skips bytes in the BinaryReader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EPOCH_OFFSET
```
public static final long EPOCH_OFFSET
```
    See Also:
    
    Constant Field Values
  - INDEX_ARRAYS
```
public static final int[][] INDEX_ARRAYS
```
- Constructor Detail
  - BinaryReader
```
public BinaryReader(BinaryReader binaryReader,
                    int position)
```
    Constructs a binary reader with the given one's byte array and an arbitrary position
    
    Parameters:
    
    binaryReader - the source BinaryReader
    
    position - the new position
  - BinaryReader
```
public BinaryReader(java.io.InputStream inputStream,
                    int size)
             throws java.io.IOException
```
    Reads size bytes from the inputStream and creates a BinaryReader for them
    
    Parameters:
    
    inputStream - the input stream
    
    size - the number of bytes
    
    Throws:
    
    java.io.IOException - if there is an error reading from the input stream
  - BinaryReader
```
public BinaryReader(byte[] bytes)
```
    Creates a BinaryReader for the given bytes
    
    Parameters:
    
    bytes - the bytes
- Method Detail
  - read
```
public int read()
```
    Reads a single byte
    
    Returns:
    
    the byte's int value
  - peek
```
public int peek()
```
    Returns the byte that would be read without changing the position
    
    Returns:
    
    the byte that would be read without changing the position
  - peekBytes
```
public byte[] peekBytes(int length)
```
    Returns the next length bytes without changing the position
    
    Parameters:
    
    length - the number of bytes
    
    Returns:
    
    the bytes
  - readBytes
```
public byte[] readBytes(int length)
```
    Reads the next length bytes
    
    Parameters:
    
    length - the number of bytes
    
    Returns:
    
    the bytes
  - readBytes
```
public void readBytes(byte[] buf,
                      int offset,
                      int length)
```
    Reads the next length bytes into the buf buffer at a given offset
    
    Parameters:
    
    buf - the buffer
    
    offset - the offset
    
    length - the number of bytes
  - readGuid
```
public java.lang.String readGuid()
```
    Reads an Evtx formatted guid (16 bytes arranged into the grouping described by INDEX_ARRAYS)
    
    Returns:
    
    the guid
  - readString
```
public java.lang.String readString(int length)
                            throws java.io.IOException
```
    Reads a string made up of single byte characters
    
    Parameters:
    
    length - the length
    
    Returns:
    
    the string
    
    Throws:
    
    java.io.IOException - if the String wasn't null terminated
  - readWString
```
public java.lang.String readWString(int length)
```
    Reads a string encoded with UTF_16LE of a given length
    
    Parameters:
    
    length - the number of characters
    
    Returns:
    
    the string
  - readQWord
```
public com.google.common.primitives.UnsignedLong readQWord()
```
    Reads 8 bytes in litte endian order and returns the UnsignedLong value
    
    Returns:
    
    the value
  - readDWord
```
public com.google.common.primitives.UnsignedInteger readDWord()
```
    Reads 4 bytes in little endian order and returns the UnsignedInteger value
    
    Returns:
    
    the value
  - readDWordBE
```
public com.google.common.primitives.UnsignedInteger readDWordBE()
```
    Reads 4 bytes in big endian order and returns the UnsignedInteger value
    
    Returns:
    
    the value
  - readWord
```
public int readWord()
```
    Reads 2 bytes in little endian order and returns the int value
    
    Returns:
    
    the value
  - readWordBE
```
public int readWordBE()
```
    Reads 2 bytes in big endian order and returns the int value
    
    Returns:
    
    the value
  - readFileTime
```
public java.util.Date readFileTime()
```
    Reads a timestamp that is the number of hundreds of nanoseconds since Jan 1 1601 (see http://integriography.wordpress.com/2010/01/16/using-phython-to-parse-and-present-windows-64-bit-timestamps/)
    
    Returns:
    
    the date corresponding to the timestamp
  - readAndBase64EncodeBinary
```
public java.lang.String readAndBase64EncodeBinary(int length)
```
    Reads length bytes and Bas64 encodes them
    
    Parameters:
    
    length - the number of bytes
    
    Returns:
    
    a Base64 encoded string
  - skip
```
public void skip(int bytes)
```
    Skips bytes in the BinaryReader
    
    Parameters:
    
    bytes - the number of bytes to skip
  - getPosition
```
public int getPosition()
```
    Returns the current position of the BinaryReader
    
    Returns:
    
    the current position
  - getBytes
```
public byte[] getBytes()
```
    Returns the backing byte array
    
    Returns:
    
    the byte array

Class BinaryReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EPOCH_OFFSET

INDEX_ARRAYS

Constructor Detail

BinaryReader

BinaryReader

BinaryReader

Method Detail

read

peek

peekBytes

readBytes

readBytes

readGuid

readString

readWString

readQWord

readDWord

readDWordBE

readWord

readWordBE

readFileTime

readAndBase64EncodeBinary

skip

getPosition

getBytes