HeapBytes (Catalyst API Reference (1.0.0-beta1))

java.lang.Object
- net.kuujo.catalyst.buffer.AbstractBytes
- - net.kuujo.catalyst.buffer.HeapBytes

All Implemented Interfaces:

AutoCloseable, Bytes, BytesInput<Bytes>, BytesOutput<Bytes>
```
public class HeapBytes
extends AbstractBytes
```
Java heap bytes.

Author:

Jordan Halterman

Field Summary
- Fields inherited from interface net.kuujo.catalyst.buffer.Bytes
  BOOLEAN, BYTE, CHARACTER, DOUBLE, FLOAT, INTEGER, LONG, MEDIUM, SHORT

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HeapBytes`	`allocate(long size)` Allocates a new heap byte array.
`byte[]`	`array()` Returns the underlying byte array.
`void`	`close()`
`HeapBytes`	`copy()` Copies the bytes to a new byte array.
`Bytes`	`flush()` Flushes the bytes to the underlying persistence layer.
`Bytes`	`read(long position, byte[] bytes, long offset, long length)` Reads bytes into the given byte array starting at the given offset up to the given length.
`Bytes`	`read(long position, Bytes bytes, long offset, long length)` Reads bytes into the given byte array starting at the given offset up to the given length.
`boolean`	`readBoolean(long offset)` Reads a 1 byte boolean from the buffer at the given offset.
`int`	`readByte(long offset)` Reads a byte from the buffer at the given offset.
`char`	`readChar(long offset)` Reads a 16-bit character from the buffer at the given offset.
`double`	`readDouble(long offset)` Reads a double-precision 64-bit floating point number from the buffer at the given offset.
`float`	`readFloat(long offset)` Reads a single-precision 32-bit floating point number from the buffer at the given offset.
`int`	`readInt(long offset)` Reads a 32-bit signed integer from the buffer at the given offset.
`long`	`readLong(long offset)` Reads a 64-bit signed integer from the buffer at the given offset.
`int`	`readMedium(long offset)` Reads a 24-bit signed integer from the buffer at the given offset.
`short`	`readShort(long offset)` Reads a 16-bit signed integer from the buffer at the given offset.
`String`	`readString(long offset)` Reads a string from the buffer at the given offset.
`int`	`readUnsignedByte(long offset)` Reads an unsigned byte from the buffer at the given offset.
`long`	`readUnsignedInt(long offset)` Reads a 32-bit unsigned integer from the buffer at the given offset.
`int`	`readUnsignedMedium(long offset)` Reads a 24-bin unsigned integer from the buffer at the given offset.
`int`	`readUnsignedShort(long offset)` Reads a 16-bit unsigned integer from the buffer at the given offset.
`String`	`readUTF8(long offset)` Reads a UTF-8 string from the buffer at the given offset.
`HeapBytes`	`reset(byte[] array)` Resets the heap byte array.
`Bytes`	`resize(long newSize)` Resizes the bytes.
`long`	`size()` Returns the count of the bytes.
`static HeapBytes`	`wrap(byte[] bytes)` Wraps the given bytes in a `HeapBytes` object.
`Bytes`	`write(long position, byte[] bytes, long offset, long length)` Writes an array of bytes to the buffer.
`Bytes`	`write(long position, Bytes bytes, long offset, long length)` Writes an array of bytes to the buffer.
`Bytes`	`writeBoolean(long offset, boolean b)` Writes a 1 byte boolean to the buffer at the given offset.
`Bytes`	`writeByte(long offset, int b)` Writes a byte to the buffer at the given offset.
`Bytes`	`writeChar(long offset, char c)` Writes a 16-bit character to the buffer at the given offset.
`Bytes`	`writeDouble(long offset, double d)` Writes a double-precision 64-bit floating point number to the buffer at the given offset.
`Bytes`	`writeFloat(long offset, float f)` Writes a single-precision 32-bit floating point number to the buffer at the given offset.
`Bytes`	`writeInt(long offset, int i)` Writes a 32-bit signed integer to the buffer at the given offset.
`Bytes`	`writeLong(long offset, long l)` Writes a 64-bit signed integer to the buffer at the given offset.
`Bytes`	`writeMedium(long offset, int m)` Writes a 24-bit signed integer to the buffer at the given offset.
`Bytes`	`writeShort(long offset, short s)` Writes a 16-bit signed integer to the buffer at the given offset.
`Bytes`	`writeString(long offset, String s)` Writes a string to the buffer at the given offset.
`Bytes`	`writeUnsignedByte(long offset, int b)` Writes an unsigned byte to the buffer at the given position.
`Bytes`	`writeUnsignedInt(long offset, long i)` Writes a 32-bit unsigned integer to the buffer at the given offset.
`Bytes`	`writeUnsignedMedium(long offset, int m)` Writes a 24-bit unsigned integer to the buffer at the given offset.
`Bytes`	`writeUnsignedShort(long offset, int s)` Writes a 16-bit unsigned integer to the buffer at the given offset.
`Bytes`	`writeUTF8(long 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(long offset)` Zeros out all bytes starting at the given offset in the array.
`Bytes`	`zero(long offset, long length)` Zeros out bytes starting at the given offset up to the given length.

Methods inherited from class net.kuujo.catalyst.buffer.AbstractBytes
isDirect, isFile, order, order

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

- Method Detail
  - allocate
```
public static HeapBytes allocate(long size)
```
    Allocates a new heap byte array.
    When the array is constructed, HeapMemoryAllocator will be used to allocate count bytes on the Java heap.
    
    Parameters:
    
    size - The count of the buffer to allocate (in bytes).
    
    Returns:
    
    The heap buffer.
    
    Throws:
    
    IllegalArgumentException - If count is greater than the maximum allowed count for an array on the Java heap - Integer.MAX_VALUE - 5
  - wrap
```
public static HeapBytes wrap(byte[] bytes)
```
    Wraps the given bytes in a HeapBytes object.
    The returned Bytes object will be backed by a HeapMemory instance that wraps the given byte array. The Bytes.size() will be equivalent to the provided by array length.
    
    Parameters:
    
    bytes - The bytes to wrap.
  - copy
```
public HeapBytes copy()
```
    Copies the bytes to a new byte array.
    
    Returns:
    
    A new HeapBytes instance backed by a copy of this instance's array.
  - array
```
public byte[] array()
```
    Returns the underlying byte array.
    
    Returns:
    
    The underlying byte array.
  - reset
```
public HeapBytes reset(byte[] array)
```
    Resets the heap byte array.
    
    Parameters:
    
    array - The internal byte array.
    
    Returns:
    
    The heap bytes.
  - size
```
public long size()
```
    Description copied from interface: Bytes
    
    Returns the count of the bytes.
    
    Returns:
    
    The count of the bytes.
  - resize
```
public Bytes resize(long 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.
  - zero
```
public Bytes zero()
```
    Description copied from interface: BytesOutput
    
    Zeros out all bytes in the array.
    
    Returns:
    
    The written bytes.
  - zero
```
public Bytes zero(long 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(long offset,
                  long 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(long position,
                  Bytes bytes,
                  long offset,
                  long 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(long position,
                  byte[] bytes,
                  long offset,
                  long 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(long 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(long offset)
```
    Description copied from interface: BytesInput
    
    Reads an unsigned byte from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the byte.
    
    Returns:
    
    The read unsigned byte.
  - readChar
```
public char readChar(long 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(long 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(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a 16-bit unsigned 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(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a 24-bit signed integer from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the integer.
    
    Returns:
    
    The read medium.
  - readUnsignedMedium
```
public int readUnsignedMedium(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a 24-bin unsigned integer from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the integer.
    
    Returns:
    
    The read medium.
  - readInt
```
public int readInt(long 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(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a 32-bit unsigned 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(long 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(long 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(long 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(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a 1 byte boolean from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the boolean.
    
    Returns:
    
    The read boolean.
  - readString
```
public String readString(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a string from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the string.
    
    Returns:
    
    The read string.
  - readUTF8
```
public String readUTF8(long offset)
```
    Description copied from interface: BytesInput
    
    Reads a UTF-8 string from the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to read the string.
    
    Returns:
    
    The read string.
  - write
```
public Bytes write(long position,
                   Bytes bytes,
                   long offset,
                   long 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(long position,
                   byte[] bytes,
                   long offset,
                   long 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(long 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(long offset,
                               int b)
```
    Description copied from interface: BytesOutput
    
    Writes an unsigned byte to the buffer at the given position.
    
    Parameters:
    
    offset - The offset at which to write the byte.
    
    b - The byte to write.
    
    Returns:
    
    The written buffer.
  - writeChar
```
public Bytes writeChar(long 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(long 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(long offset,
                                int s)
```
    Description copied from interface: BytesOutput
    
    Writes a 16-bit unsigned 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(long offset,
                         int m)
```
    Description copied from interface: BytesOutput
    
    Writes a 24-bit signed integer to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the short.
    
    m - The short to write.
    
    Returns:
    
    The written buffer.
  - writeUnsignedMedium
```
public Bytes writeUnsignedMedium(long offset,
                                 int m)
```
    Description copied from interface: BytesOutput
    
    Writes a 24-bit unsigned integer to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the short.
    
    m - The short to write.
    
    Returns:
    
    The written buffer.
  - writeInt
```
public Bytes writeInt(long 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(long offset,
                              long i)
```
    Description copied from interface: BytesOutput
    
    Writes a 32-bit unsigned 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(long 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(long 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(long 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(long offset,
                          boolean b)
```
    Description copied from interface: BytesOutput
    
    Writes a 1 byte boolean to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the boolean.
    
    b - The boolean to write.
    
    Returns:
    
    The written buffer.
  - writeString
```
public Bytes writeString(long offset,
                         String s)
```
    Description copied from interface: BytesOutput
    
    Writes a string to the buffer at the given offset.
    
    Parameters:
    
    offset - The offset at which to write the string.
    
    s - The string to write.
    
    Returns:
    
    The written buffer.
  - writeUTF8
```
public Bytes writeUTF8(long offset,
                       String s)
```
    Description copied from interface: BytesOutput
    
    Writes a UTF-8 string to the buffer at the given offset.
    
    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.
    
    Returns:
    
    The flushed buffer.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Bytes
    
    Overrides:
    
    close in class AbstractBytes

Class HeapBytes

Field Summary

Fields inherited from interface net.kuujo.catalyst.buffer.Bytes

Method Summary

Methods inherited from class net.kuujo.catalyst.buffer.AbstractBytes

Methods inherited from class java.lang.Object

Method Detail

allocate

wrap

copy

array

reset

size

resize

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