WrappedBytes (Atomix API Reference (2.0.1))

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SwappedBytes
```
public class WrappedBytes
extends AbstractBytes
```
Wrapped bytes.

Author:

Jordan Halterman

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

Constructor Summary

Constructors
Constructor and Description

WrappedBytes(Bytes bytes)

Constructors
Constructor and Description
`WrappedBytes(Bytes bytes)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`Bytes`	`flush()` Flushes the bytes to the underlying persistence layer.
`ByteOrder`	`order()` Returns the byte order.
`Bytes`	`read(int offset, byte[] dst, int dstOffset, int length)` Reads bytes into the given byte array starting at the given offset up to the given length.
`Bytes`	`read(int offset, Bytes dst, int dstOffset, int length)` Reads bytes into the given byte array starting at the given offset up to the given length.
`boolean`	`readBoolean(int offset)` Reads a 1 byte boolean from the buffer at the given offset.
`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.
`int`	`readMedium(int offset)` Reads a 24-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.
`String`	`readString(int offset)` Reads a string from the buffer at the given offset.
`int`	`readUnsignedByte(int offset)` Reads an unsigned byte from the buffer at the given offset.
`long`	`readUnsignedInt(int offset)` Reads a 32-bit unsigned integer from the buffer at the given offset.
`int`	`readUnsignedMedium(int offset)` Reads a 24-bin unsigned integer from the buffer at the given offset.
`int`	`readUnsignedShort(int offset)` Reads a 16-bit unsigned integer from the buffer at the given offset.
`String`	`readUTF8(int offset)` Reads a UTF-8 string from the buffer at the given offset.
`Bytes`	`resize(int newSize)` Resizes the bytes.
`Bytes`	`root()` Returns the root bytes.
`int`	`size()` Returns the count of the bytes.
`Bytes`	`write(int offset, byte[] src, int srcOffset, int length)` Writes an array of bytes to the buffer.
`Bytes`	`write(int offset, Bytes src, int srcOffset, int length)` Writes an array of bytes to the buffer.
`Bytes`	`writeBoolean(int offset, boolean b)` Writes a 1 byte boolean to the buffer at the given offset.
`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`	`writeMedium(int offset, int m)` Writes a 24-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`	`writeString(int offset, String s)` Writes a string to the buffer at the given offset.
`Bytes`	`writeUnsignedByte(int offset, int b)` Writes an unsigned byte to the buffer at the given position.
`Bytes`	`writeUnsignedInt(int offset, long i)` Writes a 32-bit unsigned integer to the buffer at the given offset.
`Bytes`	`writeUnsignedMedium(int offset, int m)` Writes a 24-bit unsigned integer to the buffer at the given offset.
`Bytes`	`writeUnsignedShort(int offset, int s)` Writes a 16-bit unsigned integer to the buffer at the given offset.
`Bytes`	`writeUTF8(int offset, String s)` Writes a UTF-8 string 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
isDirect, isFile, order, readString, writeString

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
array, hasArray

- Constructor Detail
  - WrappedBytes
```
public WrappedBytes(Bytes bytes)
```
- Method Detail
  - root
```
public Bytes root()
```
    Returns the root bytes.
  - size
```
public int size()
```
    Description copied from interface: Bytes
    
    Returns the count of the bytes.
    
    Returns:
    
    The count of the bytes.
  - 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.
  - 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.
  - zero
```
public Bytes zero()
```
    Description copied from interface: BytesOutput
    
    Zeros out all bytes in the array.
    
    Returns:
    
    The written 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 offset,
                  Bytes dst,
                  int dstOffset,
                  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:
    
    offset - The offset from which to start reading bytes.
    
    dst - The byte array into which to read bytes.
    
    dstOffset - 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 offset,
                  byte[] dst,
                  int dstOffset,
                  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:
    
    offset - The offset from which to start reading bytes.
    
    dst - The byte array into which to read bytes.
    
    dstOffset - The offset at which to write bytes into the given buffer
    
    length - The total number of bytes to read.
    
    Returns:
    
    The 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.
  - readUnsignedByte
```
public int readUnsignedByte(int offset)
```
    Description copied from interface: BytesInput
    
    Reads an unsigned byte from the buffer at the given offset.
    
    Specified by:
    
    readUnsignedByte in interface BytesInput<Bytes>
    
    Overrides:
    
    readUnsignedByte in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the byte.
    
    Returns:
    
    The read unsigned 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.
  - readUnsignedShort
```
public int readUnsignedShort(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 16-bit unsigned integer from the buffer at the given offset.
    
    Specified by:
    
    readUnsignedShort in interface BytesInput<Bytes>
    
    Overrides:
    
    readUnsignedShort in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the short.
    
    Returns:
    
    The read short.
  - readMedium
```
public int readMedium(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 24-bit signed integer from the buffer at the given offset.
    
    Specified by:
    
    readMedium in interface BytesInput<Bytes>
    
    Overrides:
    
    readMedium in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the integer.
    
    Returns:
    
    The read medium.
  - readUnsignedMedium
```
public int readUnsignedMedium(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 24-bin unsigned integer from the buffer at the given offset.
    
    Specified by:
    
    readUnsignedMedium in interface BytesInput<Bytes>
    
    Overrides:
    
    readUnsignedMedium in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the integer.
    
    Returns:
    
    The read medium.
  - 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.
  - readUnsignedInt
```
public long readUnsignedInt(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 32-bit unsigned integer from the buffer at the given offset.
    
    Specified by:
    
    readUnsignedInt in interface BytesInput<Bytes>
    
    Overrides:
    
    readUnsignedInt in class AbstractBytes
    
    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.
  - readBoolean
```
public boolean readBoolean(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a 1 byte boolean from the buffer at the given offset.
    
    Specified by:
    
    readBoolean in interface BytesInput<Bytes>
    
    Overrides:
    
    readBoolean in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the boolean.
    
    Returns:
    
    The read boolean.
  - readString
```
public String readString(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a string from the buffer at the given offset.
    
    Specified by:
    
    readString in interface BytesInput<Bytes>
    
    Overrides:
    
    readString in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the string.
    
    Returns:
    
    The read string.
  - readUTF8
```
public String readUTF8(int offset)
```
    Description copied from interface: BytesInput
    
    Reads a UTF-8 string from the buffer at the given offset.
    
    Specified by:
    
    readUTF8 in interface BytesInput<Bytes>
    
    Overrides:
    
    readUTF8 in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to read the string.
    
    Returns:
    
    The read string.
  - write
```
public Bytes write(int offset,
                   Bytes src,
                   int srcOffset,
                   int length)
```
    Description copied from interface: BytesOutput
    
    Writes an array of bytes to the buffer.
    
    Parameters:
    
    offset - The offset at which to start writing the bytes.
    
    src - The array of bytes to write.
    
    srcOffset - 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 offset,
                   byte[] src,
                   int srcOffset,
                   int length)
```
    Description copied from interface: BytesOutput
    
    Writes an array of bytes to the buffer.
    
    Parameters:
    
    offset - The offset at which to start writing the bytes.
    
    src - The array of bytes to write.
    
    srcOffset - 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.
  - 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.
  - writeUnsignedByte
```
public Bytes writeUnsignedByte(int offset,
                               int b)
```
    Description copied from interface: BytesOutput
    
    Writes an unsigned byte to the buffer at the given position.
    
    Specified by:
    
    writeUnsignedByte in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeUnsignedByte in class AbstractBytes
    
    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.
  - writeUnsignedShort
```
public Bytes writeUnsignedShort(int offset,
                                int s)
```
    Description copied from interface: BytesOutput
    
    Writes a 16-bit unsigned integer to the buffer at the given offset.
    
    Specified by:
    
    writeUnsignedShort in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeUnsignedShort in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to write the short.
    
    s - The short to write.
    
    Returns:
    
    The written buffer.
  - writeMedium
```
public Bytes writeMedium(int offset,
                         int m)
```
    Description copied from interface: BytesOutput
    
    Writes a 24-bit signed integer to the buffer at the given offset.
    
    Specified by:
    
    writeMedium in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeMedium in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to write the short.
    
    m - The short to write.
    
    Returns:
    
    The written buffer.
  - writeUnsignedMedium
```
public Bytes writeUnsignedMedium(int offset,
                                 int m)
```
    Description copied from interface: BytesOutput
    
    Writes a 24-bit unsigned integer to the buffer at the given offset.
    
    Specified by:
    
    writeUnsignedMedium in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeUnsignedMedium in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to write the short.
    
    m - 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.
  - writeUnsignedInt
```
public Bytes writeUnsignedInt(int offset,
                              long i)
```
    Description copied from interface: BytesOutput
    
    Writes a 32-bit unsigned integer to the buffer at the given offset.
    
    Specified by:
    
    writeUnsignedInt in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeUnsignedInt in class AbstractBytes
    
    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.
  - writeBoolean
```
public Bytes writeBoolean(int offset,
                          boolean b)
```
    Description copied from interface: BytesOutput
    
    Writes a 1 byte boolean to the buffer at the given offset.
    
    Specified by:
    
    writeBoolean in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeBoolean in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to write the boolean.
    
    b - The boolean to write.
    
    Returns:
    
    The written buffer.
  - writeString
```
public Bytes writeString(int offset,
                         String s)
```
    Description copied from interface: BytesOutput
    
    Writes a string to the buffer at the given offset.
    
    Specified by:
    
    writeString in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeString in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to write the string.
    
    s - The string to write.
    
    Returns:
    
    The written buffer.
  - writeUTF8
```
public Bytes writeUTF8(int offset,
                       String s)
```
    Description copied from interface: BytesOutput
    
    Writes a UTF-8 string to the buffer at the given offset.
    
    Specified by:
    
    writeUTF8 in interface BytesOutput<Bytes>
    
    Overrides:
    
    writeUTF8 in class AbstractBytes
    
    Parameters:
    
    offset - The offset at which to write the string.
    
    s - The string to write.
    
    Returns:
    
    The written buffer.
  - flush
```
public Bytes flush()
```
    Description copied from interface: BytesOutput
    
    Flushes the bytes to the underlying persistence layer.
    
    Specified by:
    
    flush in interface BytesOutput<Bytes>
    
    Overrides:
    
    flush in class AbstractBytes
    
    Returns:
    
    The flushed buffer.
  - close
```
public void close()
```
    Specified by:
    
    close in interface Bytes
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class AbstractBytes

Class WrappedBytes

Field Summary

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

Constructor Summary

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

Constructor Detail

WrappedBytes

Method Detail

root

size

resize

order

zero

zero

zero

read

read

readByte

readUnsignedByte

readChar

readShort

readUnsignedShort

readMedium

readUnsignedMedium

readInt

readUnsignedInt

readLong

readFloat

readDouble

readBoolean

readString

readUTF8

write

write

writeByte

writeUnsignedByte

writeChar

writeShort

writeUnsignedShort

writeMedium

writeUnsignedMedium

writeInt

writeUnsignedInt

writeLong

writeFloat

writeDouble

writeBoolean

writeString

writeUTF8

flush

close