ByteBufferReadWriteBuf (FlatBuffers Java API 1.12.0 API)

java.lang.Object
- com.google.flatbuffers.ByteBufferReadWriteBuf

public class ByteBufferReadWriteBuf
extends Object

Constructor Summary

Constructors
Constructor and Description

ByteBufferReadWriteBuf(ByteBuffer bb)

Constructors
Constructor and Description
`ByteBufferReadWriteBuf(ByteBuffer bb)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`data()` Expose ReadBuf as an array of bytes.
`byte`	`get(int index)` Read a byte from data.
`boolean`	`getBoolean(int index)` Read boolean from data.
`double`	`getDouble(int index)` Read a 64-bit float from data.
`float`	`getFloat(int index)` Read a 32-bit float from data.
`int`	`getInt(int index)` Read a 32-bit int from data.
`long`	`getLong(int index)` Read a 64-bit long from data.
`short`	`getShort(int index)` Read a short from data.
`String`	`getString(int start, int size)` Read an UTF-8 string from data.
`int`	`limit()` Defines the size of the message in the buffer.
`void`	`put(byte value)` Write a byte into the buffer at `writePosition()`.
`void`	`put(byte[] value, int start, int length)` Put an array of bytes into the buffer at `writePosition()`.
`void`	`putBoolean(boolean value)` Put a boolean into the buffer at `writePosition()` .
`void`	`putDouble(double value)` Write a 64-bit float into the buffer at `writePosition()`.
`void`	`putFloat(float value)` Write a 32-bit float into the buffer at `writePosition()`.
`void`	`putInt(int value)` Write a 32-bit into in the buffer at `writePosition()`.
`void`	`putLong(long value)` Write a 64-bit into in the buffer at `writePosition()`.
`void`	`putShort(short value)` Write a 16-bit into in the buffer at `writePosition()`.
`boolean`	`requestCapacity(int capacity)` Request capacity of the buffer.
`void`	`set(int index, byte value)` Read a byte from data.
`void`	`set(int index, byte[] value, int start, int length)` Write an array of bytes into the buffer.
`void`	`setBoolean(int index, boolean value)` Write boolean into a given position on the buffer.
`void`	`setDouble(int index, double value)` Read a 64-bit float from data.
`void`	`setFloat(int index, float value)` Read a 32-bit float from data.
`void`	`setInt(int index, int value)` Read a 32-bit int from data.
`void`	`setLong(int index, long value)` Read a 64-bit long from data.
`void`	`setShort(int index, short value)` Read a short from data.
`int`	`writePosition()`

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

- Constructor Detail
  - ByteBufferReadWriteBuf
```
public ByteBufferReadWriteBuf(ByteBuffer bb)
```
- Method Detail
  - getBoolean
```
public boolean getBoolean(int index)
```
    Read boolean from data. Booleans as stored as single byte
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    boolean element
  - get
```
public byte get(int index)
```
    Read a byte from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    a byte
  - getShort
```
public short getShort(int index)
```
    Read a short from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    a short
  - getInt
```
public int getInt(int index)
```
    Read a 32-bit int from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    an int
  - getLong
```
public long getLong(int index)
```
    Read a 64-bit long from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    a long
  - getFloat
```
public float getFloat(int index)
```
    Read a 32-bit float from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    a float
  - getDouble
```
public double getDouble(int index)
```
    Read a 64-bit float from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
    
    Returns:
    
    a double
  - getString
```
public String getString(int start,
                        int size)
```
    Read an UTF-8 string from data.
    
    Parameters:
    
    start - initial element of the string
    
    size - size of the string in bytes.
    
    Returns:
    
    a String
  - data
```
public byte[] data()
```
    Expose ReadBuf as an array of bytes. This method is meant to be as efficient as possible, so for a array-backed ReadBuf, it should return its own internal data. In case access to internal data is not possible, a copy of the data into an array of bytes might occur.
    
    Returns:
    
    ReadBuf as an array of bytes
  - putBoolean
```
public void putBoolean(boolean value)
```
    Put a boolean into the buffer at writePosition() . Booleans as stored as single byte. Write position will be incremented.
  - put
```
public void put(byte[] value,
                int start,
                int length)
```
    Put an array of bytes into the buffer at writePosition(). Write position will be incremented.
    
    Parameters:
    
    value - the data to be copied
    
    start - initial position on value to be copied
    
    length - amount of bytes to be copied
  - put
```
public void put(byte value)
```
    Write a byte into the buffer at writePosition(). Write position will be incremented.
  - putShort
```
public void putShort(short value)
```
    Write a 16-bit into in the buffer at writePosition(). Write position will be incremented.
  - putInt
```
public void putInt(int value)
```
    Write a 32-bit into in the buffer at writePosition(). Write position will be incremented.
  - putLong
```
public void putLong(long value)
```
    Write a 64-bit into in the buffer at writePosition(). Write position will be incremented.
  - putFloat
```
public void putFloat(float value)
```
    Write a 32-bit float into the buffer at writePosition(). Write position will be incremented.
  - putDouble
```
public void putDouble(double value)
```
    Write a 64-bit float into the buffer at writePosition(). Write position will be incremented.
  - setBoolean
```
public void setBoolean(int index,
                       boolean value)
```
    Write boolean into a given position on the buffer. Booleans as stored as single byte.
    
    Parameters:
    
    index - position of the element in buffer
  - set
```
public void set(int index,
                byte value)
```
    Read a byte from data.
    
    Parameters:
    
    index - position of the element in the buffer
  - set
```
public void set(int index,
                byte[] value,
                int start,
                int length)
```
    Write an array of bytes into the buffer.
    
    Parameters:
    
    index - initial position of the buffer to be written
    
    value - the data to be copied
    
    start - initial position on value to be copied
    
    length - amount of bytes to be copied
  - setShort
```
public void setShort(int index,
                     short value)
```
    Read a short from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
  - setInt
```
public void setInt(int index,
                   int value)
```
    Read a 32-bit int from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
  - setLong
```
public void setLong(int index,
                    long value)
```
    Read a 64-bit long from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
  - setFloat
```
public void setFloat(int index,
                     float value)
```
    Read a 32-bit float from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
  - setDouble
```
public void setDouble(int index,
                      double value)
```
    Read a 64-bit float from data.
    
    Parameters:
    
    index - position of the element in ReadBuf
  - writePosition
```
public int writePosition()
```
  - limit
```
public int limit()
```
    Defines the size of the message in the buffer. It also determines last position that buffer can be read or write. Last byte to be accessed is in position limit() -1.
    
    Returns:
    
    indicate last position
  - requestCapacity
```
public boolean requestCapacity(int capacity)
```
    Request capacity of the buffer. In case buffer is already larger than the requested, this method will just return true. Otherwise It might try to resize the buffer.
    
    Returns:
    
    true if buffer is able to offer the requested capacity

Class ByteBufferReadWriteBuf

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteBufferReadWriteBuf

Method Detail

getBoolean

get

getShort

getInt

getLong

getFloat

getDouble

getString

data

putBoolean

put

put

putShort

putInt

putLong

putFloat

putDouble

setBoolean

set

set

setShort

setInt

setLong

setFloat

setDouble

writePosition

limit

requestCapacity