ByteBufferBytes (Atomix API Reference (2.0.20))

java.lang.Object
- io.atomix.storage.buffer.AbstractBytes
- - io.atomix.storage.buffer.ByteBufferBytes

All Implemented Interfaces:

Bytes, BytesInput<Bytes>, BytesOutput<Bytes>, AutoCloseable

Direct Known Subclasses:

DirectBytes, HeapBytes, MappedBytes
```
public abstract class ByteBufferBytes
extends AbstractBytes
```
Byte buffer bytes.

Field Summary
- Fields inherited from interface io.atomix.storage.buffer.Bytes
  BOOLEAN, BYTE, CHARACTER, DOUBLE, FLOAT, INTEGER, LONG, MEDIUM, SHORT

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`array()` Returns the underlying byte array.
`ByteBuffer`	`byteBuffer()` Returns the underlying `ByteBuffer`.
`ByteOrder`	`order()` Returns the byte order.
`Bytes`	`order(ByteOrder order)` Sets the byte order, returning a new swapped `Bytes` instance.
`Bytes`	`read(int position, byte[] bytes, int offset, int length)` Reads bytes into the given byte array starting at the given offset up to the given length.
`Bytes`	`read(int position, Bytes bytes, int offset, int length)` Reads bytes into the given byte array starting at the given offset up to the given length.
`int`	`readByte(int offset)` Reads a byte from the buffer at the given offset.
`char`	`readChar(int offset)` Reads a 16-bit character from the buffer at the given offset.
`double`	`readDouble(int offset)` Reads a double-precision 64-bit floating point number from the buffer at the given offset.
`float`	`readFloat(int offset)` Reads a single-precision 32-bit floating point number from the buffer at the given offset.
`int`	`readInt(int offset)` Reads a 32-bit signed integer from the buffer at the given offset.
`long`	`readLong(int offset)` Reads a 64-bit signed integer from the buffer at the given offset.
`short`	`readShort(int offset)` Reads a 16-bit signed integer from the buffer at the given offset.
`Bytes`	`reset(ByteBuffer buffer)`
`Bytes`	`resize(int newSize)` Resizes the bytes.
`int`	`size()` Returns the count of the bytes.
`Bytes`	`write(int position, byte[] bytes, int offset, int length)` Writes an array of bytes to the buffer.
`Bytes`	`write(int position, Bytes bytes, int offset, int length)` Writes an array of bytes to the buffer.
`Bytes`	`writeByte(int offset, int b)` Writes a byte to the buffer at the given offset.
`Bytes`	`writeChar(int offset, char c)` Writes a 16-bit character to the buffer at the given offset.
`Bytes`	`writeDouble(int offset, double d)` Writes a double-precision 64-bit floating point number to the buffer at the given offset.
`Bytes`	`writeFloat(int offset, float f)` Writes a single-precision 32-bit floating point number to the buffer at the given offset.
`Bytes`	`writeInt(int offset, int i)` Writes a 32-bit signed integer to the buffer at the given offset.
`Bytes`	`writeLong(int offset, long l)` Writes a 64-bit signed integer to the buffer at the given offset.
`Bytes`	`writeShort(int offset, short s)` Writes a 16-bit signed integer to the buffer at the given offset.
`Bytes`	`zero()` Zeros out all bytes in the array.
`Bytes`	`zero(int offset)` Zeros out all bytes starting at the given offset in the array.
`Bytes`	`zero(int offset, int length)` Zeros out bytes starting at the given offset up to the given length.

Methods inherited from class io.atomix.storage.buffer.AbstractBytes
close, flush, isDirect, isFile, readBoolean, readMedium, readString, readString, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, readUTF8, writeBoolean, writeMedium, writeString, writeString, writeUnsignedByte, writeUnsignedInt, writeUnsignedMedium, writeUnsignedShort, writeUTF8

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

Methods inherited from interface io.atomix.storage.buffer.Bytes
hasArray

- Method Detail
  - reset
```
public Bytes reset(ByteBuffer buffer)
```
  - resize
```
public Bytes resize(int newSize)
```
    Description copied from interface: Bytes
    
    Resizes the bytes.
    When the bytes are resized, underlying memory addresses in copies of this instance may no longer be valid. Additionally, if the newSize is smaller than the current count then some data may be lost during the resize. Use with caution.
    
    Parameters:
    
    newSize - The count to which to resize this instance.
    
    Returns:
    
    The resized bytes.
  - array
```
public byte[] array()
```
    Description copied from interface: Bytes
    
    Returns the underlying byte array.
    
    Returns:
    
    the underlying byte array
  - byteBuffer
```
public ByteBuffer byteBuffer()
```
    Returns the underlying ByteBuffer.
    
    Returns:
    
    the underlying byte buffer
  - zero
```
public Bytes zero()
```
    Description copied from interface: BytesOutput
    
    Zeros out all bytes in the array.
    
    Returns:
    
    The written bytes.
  - size
```
public int size()
```
    Description copied from interface: Bytes
    
    Returns the count of the bytes.
    
    Returns:
    
    The count of the bytes.
  - order
```
public ByteOrder order()
```
    Description copied from interface: Bytes
    
    Returns the byte order.
    For consistency with ByteBuffer, all bytes implementations are initially in ByteOrder.BIG_ENDIAN order.
    
    Specified by:
    
    order in interface Bytes
    
    Overrides:
    
    order in class AbstractBytes
    
    Returns:
    
    The byte order.
  - order
```
public Bytes order(ByteOrder order)
```
    Description copied from interface: Bytes
    
    Sets the byte order, returning a new swapped Bytes instance.
    By default, all bytes are read and written in ByteOrder.BIG_ENDIAN order. This provides complete consistency with ByteBuffer. To flip bytes to ByteOrder.LITTLE_ENDIAN order, this Bytes instance is decorated by a SwappedBytes instance which will reverse read and written bytes using, e.g. Integer.reverseBytes(int).
    
    Specified by:
    
    order in interface Bytes
    
    Overrides:
    
    order in class AbstractBytes
    
    Parameters:
    
    order - The byte order.
    
    Returns:
    
    The updated bytes.
  - zero
```
public Bytes zero(int offset)
```
    Description copied from interface: BytesOutput
    
    Zeros out all bytes starting at the given offset in the array.
    
    Parameters:
    
    offset - The offset at which to start zeroing out bytes.
    
    Returns:
    
    The written bytes.
  - zero
```
public Bytes zero(int offset,
                  int length)
```
    Description copied from interface: BytesOutput
    
    Zeros out bytes starting at the given offset up to the given length.
    
    Parameters:
    
    offset - The offset at which to start zeroing out bytes.
    
    length - THe total number of bytes to zero out.
    
    Returns:
    
    The written bytes.
  - read
```
public Bytes read(int position,
                  byte[] bytes,
                  int offset,
                  int length)
```
    Description copied from interface: BytesInput
    
    Reads bytes into the given byte array starting at the given offset up to the given length.
    
    Parameters:
    
    position - The offset from which to start reading bytes.
    
    bytes - The byte array into which to read bytes.
    
    offset - The offset at which to write bytes into the given buffer
    
    length - The total number of bytes to read.
    
    Returns:
    
    The buffer.
  - read
```
public Bytes read(int position,
                  Bytes bytes,
                  int offset,
                  int length)
```
    Description copied from interface: BytesInput
    
    Reads bytes into the given byte array starting at the given offset up to the given length.
    
    Parameters:
    
    position - The offset from which to start reading bytes.
    
    bytes - The byte array into which to read bytes.
    
    offset - The offset at which to write bytes into the given buffer.
    
    length - The total number of bytes to read.
    
    Returns:
    
    The buffer.
  - write
```
public Bytes write(int position,
                   byte[] bytes,
                   int offset,
                   int length)
```
    Description copied from interface: BytesOutput
    
    Writes an array of bytes to the buffer.
    
    Parameters:
    
    position - The offset at which to start writing the bytes.
    
    bytes - The array of bytes to write.
    
    offset - The offset at which to start reading bytes from the given source.
    
    length - The number of bytes from the provided byte array to write to the buffer.
    
    Returns:
    
    The written buffer.
  - write
```
public Bytes write(int position,
                   Bytes bytes,
                   int offset,
                   int length)
```
    Description copied from interface: BytesOutput
    
    Writes an array of bytes to the buffer.
    
    Parameters:
    
    position - The offset at which to start writing the bytes.
    
    bytes - The array of bytes to write.
    
    offset - The offset at which to start reading bytes from the given source.
    
    length - The number of bytes from the provided byte array to write to the buffer.
    
    Returns:
    
    The written buffer.
  - readByte
```
public int readByte(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a byte from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the byte.
    
    Returns:
    
    The read byte.
  - readChar
```
public char readChar(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 16-bit character from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the character.
    
    Returns:
    
    The read character.
  - readShort
```
public short readShort(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 16-bit signed integer from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the short.
    
    Returns:
    
    The read short.
  - readInt
```
public int readInt(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 32-bit signed integer from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the integer.
    
    Returns:
    
    The read integer.
  - readLong
```
public long readLong(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 64-bit signed integer from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the long.
    
    Returns:
    
    The read long.
  - readFloat
```
public float readFloat(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a single-precision 32-bit floating point number from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the float.
    
    Returns:
    
    The read float.
  - readDouble
```
public double readDouble(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a double-precision 64-bit floating point number from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the double.
    
    Returns:
    
    The read double.
  - writeByte
```
public Bytes writeByte(int offset,
                       int b)
```
    Description copied from interface: BytesOutput
    
    Writes a byte to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the byte.
    
    b - The byte to write.
    
    Returns:
    
    The written buffer.
  - writeChar
```
public Bytes writeChar(int offset,
                       char c)
```
    Description copied from interface: BytesOutput
    
    Writes a 16-bit character to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the character.
    
    c - The character to write.
    
    Returns:
    
    The written buffer.
  - writeShort
```
public Bytes writeShort(int offset,
                        short s)
```
    Description copied from interface: BytesOutput
    
    Writes a 16-bit signed integer to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the short.
    
    s - The short to write.
    
    Returns:
    
    The written buffer.
  - writeInt
```
public Bytes writeInt(int offset,
                      int i)
```
    Description copied from interface: BytesOutput
    
    Writes a 32-bit signed integer to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the integer.
    
    i - The integer to write.
    
    Returns:
    
    The written buffer.
  - writeLong
```
public Bytes writeLong(int offset,
                       long l)
```
    Description copied from interface: BytesOutput
    
    Writes a 64-bit signed integer to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the long.
    
    l - The long to write.
    
    Returns:
    
    The written buffer.
  - writeFloat
```
public Bytes writeFloat(int offset,
                        float f)
```
    Description copied from interface: BytesOutput
    
    Writes a single-precision 32-bit floating point number to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the float.
    
    f - The float to write.
    
    Returns:
    
    The written buffer.
  - writeDouble
```
public Bytes writeDouble(int offset,
                         double d)
```
    Description copied from interface: BytesOutput
    
    Writes a double-precision 64-bit floating point number to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the double.
    
    d - The double to write.
    
    Returns:
    
    The written buffer.

Class ByteBufferBytes

Field Summary

Fields inherited from interface io.atomix.storage.buffer.Bytes

Method Summary

Methods inherited from class io.atomix.storage.buffer.AbstractBytes

Methods inherited from class java.lang.Object

Methods inherited from interface io.atomix.storage.buffer.Bytes

Method Detail

reset

resize

array

byteBuffer

zero

size

order

order

zero

zero

read

read

write

write

readByte

readChar

readShort

readInt

readLong

readFloat

readDouble

writeByte

writeChar

writeShort

writeInt

writeLong

writeFloat

writeDouble