ByteBlock (Concourse Java API)

All Known Implementing Classes:

HeapByteBlock
```
public interface ByteBlock
```
An elastic binary buffer that grows dynamically as bytes are added.
An ByteBlock operates in two sequential modes: write mode and read mode. In write mode, data is appended through typed write methods and the buffer elastically expands to accommodate any amount of data. Calling flip() transitions the buffer to read mode, after which the written data can be consumed through the corresponding typed read methods.

Unlike ByteBuffer, an ByteBlock does not require the caller to pre-calculate or declare a fixed capacity. The buffer grows as needed, making it suitable for serialization tasks where the final size is not known in advance.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`byte[]`	`array()` Return the backing byte array.
`ByteBlock`	`flip()` Transition from write mode to read mode.
`boolean`	`hasRemaining()` Return `true` if there are bytes remaining to be read.
`long`	`position()` Return the current position — the number of bytes written so far (in write mode) or the number of bytes read so far (in read mode).
`ByteBlock`	`read(byte[] dest)` Read bytes into the provided array, filling it completely.
`ByteBlock`	`read(byte[] dest, int offset, int length)` Read `length` bytes into `dest` starting at `offset`.
`boolean`	`readBoolean()` Read a boolean written by `writeBoolean(boolean)`.
`int`	`readByte()` Read a single byte.
`char`	`readChar()` Read a 2-byte char in big-endian order.
`double`	`readDouble()` Read an 8-byte double in IEEE 754 format, big-endian order.
`float`	`readFloat()` Read a 4-byte float in IEEE 754 format, big-endian order.
`int`	`readInt()` Read a 4-byte integer in big-endian order.
`long`	`readLong()` Read an 8-byte long in big-endian order.
`short`	`readShort()` Read a 2-byte short in big-endian order.
`String`	`readUtf8()` Read a UTF-8 encoded string written by `writeUtf8(String)`.
`long`	`remaining()` Return the number of bytes remaining to be read (in read mode) or the number of bytes written so far (in write mode).
`ByteBlock`	`write(byte[] bytes)` Write a raw byte array.
`ByteBlock`	`write(byte[] bytes, int offset, int length)` Write `length` bytes from `bytes` starting at `offset`.
`ByteBlock`	`writeBoolean(boolean value)` Write a boolean as a single byte (`1` for `true`, `0` for `false`).
`ByteBlock`	`writeByte(int value)` Write a single byte.
`ByteBlock`	`writeChar(char value)` Write a 2-byte char in big-endian order.
`ByteBlock`	`writeDouble(double value)` Write an 8-byte double in IEEE 754 format, big-endian order.
`ByteBlock`	`writeFloat(float value)` Write a 4-byte float in IEEE 754 format, big-endian order.
`ByteBlock`	`writeInt(int value)` Write a 4-byte integer in big-endian order.
`ByteBlock`	`writeLong(long value)` Write an 8-byte long in big-endian order.
`ByteBlock`	`writeShort(short value)` Write a 2-byte short in big-endian order.
`ByteBlock`	`writeUtf8(String value)` Write a UTF-8 encoded string with a length prefix.

- Method Detail
  - writeByte
```
ByteBlock writeByte(int value)
```
    Write a single byte.
    
    Parameters:
    
    value - the byte value (only the lowest 8 bits are used)
    
    Returns:
    
    this ByteBlock
  - writeShort
```
ByteBlock writeShort(short value)
```
    Write a 2-byte short in big-endian order.
    
    Parameters:
    
    value - the short value
    
    Returns:
    
    this ByteBlock
  - writeChar
```
ByteBlock writeChar(char value)
```
    Write a 2-byte char in big-endian order.
    
    Parameters:
    
    value - the char value
    
    Returns:
    
    this ByteBlock
  - writeInt
```
ByteBlock writeInt(int value)
```
    Write a 4-byte integer in big-endian order.
    
    Parameters:
    
    value - the int value
    
    Returns:
    
    this ByteBlock
  - writeFloat
```
ByteBlock writeFloat(float value)
```
    Write a 4-byte float in IEEE 754 format, big-endian order.
    
    Parameters:
    
    value - the float value
    
    Returns:
    
    this ByteBlock
  - writeLong
```
ByteBlock writeLong(long value)
```
    Write an 8-byte long in big-endian order.
    
    Parameters:
    
    value - the long value
    
    Returns:
    
    this ByteBlock
  - writeDouble
```
ByteBlock writeDouble(double value)
```
    Write an 8-byte double in IEEE 754 format, big-endian order.
    
    Parameters:
    
    value - the double value
    
    Returns:
    
    this ByteBlock
  - writeBoolean
```
ByteBlock writeBoolean(boolean value)
```
    Write a boolean as a single byte (1 for true, 0 for false).
    
    Parameters:
    
    value - the boolean value
    
    Returns:
    
    this ByteBlock
  - writeUtf8
```
ByteBlock writeUtf8(@Nullable
                    String value)
```
    Write a UTF-8 encoded string with a length prefix.
    A null string is supported and will be read back as null by readUtf8().
    
    Parameters:
    
    value - the string to write, or null
    
    Returns:
    
    this ByteBlock
  - write
```
ByteBlock write(byte[] bytes)
```
    Write a raw byte array.
    
    Parameters:
    
    bytes - the bytes to write
    
    Returns:
    
    this ByteBlock
  - write
```
ByteBlock write(byte[] bytes,
                int offset,
                int length)
```
    Write length bytes from bytes starting at offset.
    
    Parameters:
    
    bytes - the source byte array
    
    offset - the start offset in the source
    
    length - the number of bytes to write
    
    Returns:
    
    this ByteBlock
  - readByte
```
int readByte()
```
    Read a single byte.
    
    Returns:
    
    the byte value as an unsigned int (0–255)
  - readShort
```
short readShort()
```
    Read a 2-byte short in big-endian order.
    
    Returns:
    
    the short value
  - readChar
```
char readChar()
```
    Read a 2-byte char in big-endian order.
    
    Returns:
    
    the char value
  - readInt
```
int readInt()
```
    Read a 4-byte integer in big-endian order.
    
    Returns:
    
    the int value
  - readFloat
```
float readFloat()
```
    Read a 4-byte float in IEEE 754 format, big-endian order.
    
    Returns:
    
    the float value
  - readLong
```
long readLong()
```
    Read an 8-byte long in big-endian order.
    
    Returns:
    
    the long value
  - readDouble
```
double readDouble()
```
    Read an 8-byte double in IEEE 754 format, big-endian order.
    
    Returns:
    
    the double value
  - readBoolean
```
boolean readBoolean()
```
    Read a boolean written by writeBoolean(boolean).
    
    Returns:
    
    the boolean value
  - readUtf8
```
@Nullable
String readUtf8()
```
    Read a UTF-8 encoded string written by writeUtf8(String).
    
    Returns:
    
    the string, or null if null was written
  - read
```
ByteBlock read(byte[] dest)
```
    Read bytes into the provided array, filling it completely.
    
    Parameters:
    
    dest - the destination byte array
    
    Returns:
    
    this ByteBlock
  - read
```
ByteBlock read(byte[] dest,
               int offset,
               int length)
```
    Read length bytes into dest starting at offset.
    
    Parameters:
    
    dest - the destination byte array
    
    offset - the start offset in the destination
    
    length - the number of bytes to read
    
    Returns:
    
    this ByteBlock
  - flip
```
ByteBlock flip()
```
    Transition from write mode to read mode. After this call, the buffer's position is reset to zero and remaining() reflects the total number of bytes that were written.
    
    Returns:
    
    this ByteBlock
  - hasRemaining
```
boolean hasRemaining()
```
    Return true if there are bytes remaining to be read.
    
    Returns:
    
    true if bytes remain
  - remaining
```
long remaining()
```
    Return the number of bytes remaining to be read (in read mode) or the number of bytes written so far (in write mode).
    
    Returns:
    
    the remaining or written byte count
  - position
```
long position()
```
    Return the current position — the number of bytes written so far (in write mode) or the number of bytes read so far (in read mode).
    
    Returns:
    
    the current position
  - array
```
byte[] array()
```
    Return the backing byte array. In write mode, this returns a copy of the bytes written so far. In read mode, this returns the backing array from which data is being read.
    
    Returns:
    
    the byte array

Interface ByteBlock

Method Summary

Method Detail

writeByte

writeShort

writeChar

writeInt

writeFloat

writeLong

writeDouble

writeBoolean

writeUtf8

write

write

readByte

readShort

readChar

readInt

readFloat

readLong

readDouble

readBoolean

readUtf8

read

read

flip

hasRemaining

remaining

position

array