NativeBytes (Atomix API Reference (2.0.19))

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

All Implemented Interfaces:

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

Direct Known Subclasses:

UnsafeDirectBytes, UnsafeMappedBytes
```
public abstract class NativeBytes
extends AbstractBytes
```
Native bytes.
Bytes are read from and written to the JVM's underlying static Unsafe instance. Bytes are read in ByteOrder.nativeOrder() order and if necessary bytes are reversed to ByteOrder.BIG_ENDIAN order.

Author:

Jordan Halterman

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
`void`	`close()`
`boolean`	`isDirect()` Returns a boolean value indicating whether the bytes are direct.
`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.
`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.
`int`	`readUnsignedMedium(int offset)` Reads a 24-bin unsigned integer from the buffer at the given offset.
`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`	`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`	`writeUnsignedMedium(int offset, int m)` Writes a 24-bit unsigned 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
flush, isFile, order, order, readBoolean, readString, readString, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF8, writeBoolean, writeString, writeString, writeUnsignedByte, writeUnsignedInt, 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
array, hasArray

- Method Detail
  - 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.
  - isDirect
```
public boolean isDirect()
```
    Description copied from interface: Bytes
    
    Returns a boolean value indicating whether the bytes are direct.
    
    Specified by:
    
    isDirect in interface Bytes
    
    Overrides:
    
    isDirect in class AbstractBytes
    
    Returns:
    
    Indicates whether the bytes are direct.
  - 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 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface Bytes
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class AbstractBytes

Class NativeBytes

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

size

resize

isDirect

zero

zero

zero

read

read

readByte

readChar

readShort

readMedium

readUnsignedMedium

readInt

readLong

readFloat

readDouble

write

write

writeByte

writeChar

writeShort

writeMedium

writeUnsignedMedium

writeInt

writeLong

writeFloat

writeDouble

close