NativeBuffer (JavaNativeUtilsApi 4.2 API)

All Superinterfaces:

DataInput, DataOutput
```
public interface NativeBuffer
extends DataInput, DataOutput
```
Stream like representation of a NativeMemory object. Can be useful in constructing/reading structs when one does not want to keep track of the indices.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`capacity()` Returns the size of backing NativeMemory.
`long`	`getOffset()` Returns the offset of this NativeBuffer in its backing NativeMemory.
`long`	`getPosition()` Returns the number of bytes written to this native buffer
`long`	`getStartOffset()` Returns the offset of this NativeBuffer in its backing NativeMemory that it would have after a call to setPosition(0).
`NativeMemory`	`memory()` Returns the memory that this NativeBuffer backs or null if it is not backed by NativeMemory.
`boolean`	`readBoolean()`
`byte`	`readByte()`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`void`	`readFully(byte[] b)`
`void`	`readFully(byte[] b, int off, int len)`
`int`	`readInt()`
`String`	`readLine()`
`long`	`readLong()`
`short`	`readShort()`
`int`	`readUnsignedByte()`
`int`	`readUnsignedShort()`
`String`	`readUTF()`
`String`	`readZeroTerminatedUTF8()` the returned string does not end with the 0 byte.
`long`	`remaining()` Returns the exact number of bytes that can be read from this NativeBuffer.
`boolean`	`setOffset(long offset)` Change the offset in the native memory.
`boolean`	`setPosition(long position)` Changes the offset so that getPosition() would return the given number.
`int`	`skipBytes(int n)`
`void`	`write(byte[] b)`
`void`	`write(byte[] b, int off, int len)`
`void`	`write(byte value, long len)` writes the value 'value' len times.
`void`	`write(int b)`
`void`	`writeBoolean(boolean v)`
`void`	`writeByte(int v)`
`void`	`writeBytes(String s)`
`void`	`writeChar(int v)`
`void`	`writeChars(String s)`
`void`	`writeDouble(double v)`
`void`	`writeFloat(float v)`
`void`	`writeInt(int v)`
`void`	`writeLong(long v)`
`void`	`writeShort(int v)`
`void`	`writeUTF(String s)`
`void`	`writeZeroTerminatedUTF8(String str)` Writes a zero terminated utf8 string.

- Method Detail
  - write
```
void write(int b)
```
    Specified by:
    
    write in interface DataOutput
  - write
```
void write(byte[] b)
```
    Specified by:
    
    write in interface DataOutput
  - write
```
void write(byte[] b,
           int off,
           int len)
```
    Specified by:
    
    write in interface DataOutput
  - writeBoolean
```
void writeBoolean(boolean v)
```
    Specified by:
    
    writeBoolean in interface DataOutput
  - writeByte
```
void writeByte(int v)
```
    Specified by:
    
    writeByte in interface DataOutput
  - writeShort
```
void writeShort(int v)
```
    Specified by:
    
    writeShort in interface DataOutput
  - writeChar
```
void writeChar(int v)
```
    Specified by:
    
    writeChar in interface DataOutput
  - writeInt
```
void writeInt(int v)
```
    Specified by:
    
    writeInt in interface DataOutput
  - writeLong
```
void writeLong(long v)
```
    Specified by:
    
    writeLong in interface DataOutput
  - writeFloat
```
void writeFloat(float v)
```
    Specified by:
    
    writeFloat in interface DataOutput
  - writeDouble
```
void writeDouble(double v)
```
    Specified by:
    
    writeDouble in interface DataOutput
  - writeBytes
```
void writeBytes(String s)
```
    Specified by:
    
    writeBytes in interface DataOutput
  - writeChars
```
void writeChars(String s)
```
    Specified by:
    
    writeChars in interface DataOutput
  - writeUTF
```
void writeUTF(String s)
```
    Specified by:
    
    writeUTF in interface DataOutput
  - readFully
```
void readFully(byte[] b)
```
    Specified by:
    
    readFully in interface DataInput
  - readFully
```
void readFully(byte[] b,
               int off,
               int len)
```
    Specified by:
    
    readFully in interface DataInput
  - skipBytes
```
int skipBytes(int n)
```
    Specified by:
    
    skipBytes in interface DataInput
  - readBoolean
```
boolean readBoolean()
```
    Specified by:
    
    readBoolean in interface DataInput
  - readByte
```
byte readByte()
```
    Specified by:
    
    readByte in interface DataInput
  - readUnsignedByte
```
int readUnsignedByte()
```
    Specified by:
    
    readUnsignedByte in interface DataInput
  - readShort
```
short readShort()
```
    Specified by:
    
    readShort in interface DataInput
  - readUnsignedShort
```
int readUnsignedShort()
```
    Specified by:
    
    readUnsignedShort in interface DataInput
  - readChar
```
char readChar()
```
    Specified by:
    
    readChar in interface DataInput
  - readInt
```
int readInt()
```
    Specified by:
    
    readInt in interface DataInput
  - readLong
```
long readLong()
```
    Specified by:
    
    readLong in interface DataInput
  - readFloat
```
float readFloat()
```
    Specified by:
    
    readFloat in interface DataInput
  - readDouble
```
double readDouble()
```
    Specified by:
    
    readDouble in interface DataInput
  - readLine
```
String readLine()
```
    Specified by:
    
    readLine in interface DataInput
  - readUTF
```
String readUTF()
```
    Specified by:
    
    readUTF in interface DataInput
  - readZeroTerminatedUTF8
```
String readZeroTerminatedUTF8()
```
    the returned string does not end with the 0 byte.
  - writeZeroTerminatedUTF8
```
void writeZeroTerminatedUTF8(String str)
```
    Writes a zero terminated utf8 string.
    
    Parameters:
    
    str - should not contain or end with the '0' byte character.
  - write
```
void write(byte value,
           long len)
```
    writes the value 'value' len times.
  - memory
```
NativeMemory memory()
```
    Returns the memory that this NativeBuffer backs or null if it is not backed by NativeMemory. The memory can be used to access the data in a random access fashion.
  - getOffset
```
long getOffset()
```
    Returns the offset of this NativeBuffer in its backing NativeMemory. Note: this does not contain the number of bytes written this contains the offset relative to the start of the backing NativeMemory. call getPosition() for that. Returns -1 in case a call to memory() would return null;
  - getPosition
```
long getPosition()
```
    Returns the number of bytes written to this native buffer
  - remaining
```
long remaining()
```
    Returns the exact number of bytes that can be read from this NativeBuffer. Returns -1 if this number is not known or cannot be exactly determined.
  - capacity
```
long capacity()
```
    Returns the size of backing NativeMemory.
  - getStartOffset
```
long getStartOffset()
```
    Returns the offset of this NativeBuffer in its backing NativeMemory that it would have after a call to setPosition(0). Returns -1 if the NativeBuffer does not support setting positions. This call does not modify any offsets/positions of the NativeBuffer.
  - setPosition
```
boolean setPosition(long position)
```
    Changes the offset so that getPosition() would return the given number. Returns false if the NativeBuffer does not support setting positions. In that case the call was a noop.
  - setOffset
```
boolean setOffset(long offset)
```
    Change the offset in the native memory. This resets the position to zero. Returns false if the NativeBuffer does not support setting positions. In this case the call was a noop.

Interface NativeBuffer

Method Summary

Method Detail

write

write

write

writeBoolean

writeByte

writeShort

writeChar

writeInt

writeLong

writeFloat

writeDouble

writeBytes

writeChars

writeUTF

readFully

readFully

skipBytes

readBoolean

readByte

readUnsignedByte

readShort

readUnsignedShort

readChar

readInt

readLong

readFloat

readDouble

readLine

readUTF

readZeroTerminatedUTF8

writeZeroTerminatedUTF8

write

memory

getOffset

getPosition

remaining

capacity

getStartOffset

setPosition

setOffset