net.kuujo.catalyst.buffer

Interface BytesOutput<T extends BytesOutput<T>>

All Known Subinterfaces:

Buffer, Bytes

All Known Implementing Classes:

AbstractBuffer, AbstractBytes, DirectBuffer, DirectBytes, FileBuffer, FileBytes, HeapBuffer, HeapBytes, MappedBuffer, MappedBytes, NativeBuffer, NativeBytes, ReadOnlyBuffer, SlicedBuffer, SwappedBuffer, SwappedBytes, WrappedBytes

public interface BytesOutput<T extends BytesOutput<T>>

Writable bytes.

This interface exposes methods for writing bytes to specific positions in a byte array.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
T	flush() Flushes the bytes to the underlying persistence layer.
T	write(long offset, byte[] src, long srcOffset, long length) Writes an array of bytes to the buffer.
T	write(long offset, Bytes src, long srcOffset, long length) Writes an array of bytes to the buffer.
T	writeBoolean(long offset, boolean b) Writes a 1 byte boolean to the buffer at the given offset.
T	writeByte(long offset, int b) Writes a byte to the buffer at the given offset.
T	writeChar(long offset, char c) Writes a 16-bit character to the buffer at the given offset.
T	writeDouble(long offset, double d) Writes a double-precision 64-bit floating point number to the buffer at the given offset.
T	writeFloat(long offset, float f) Writes a single-precision 32-bit floating point number to the buffer at the given offset.
T	writeInt(long offset, int i) Writes a 32-bit signed integer to the buffer at the given offset.
T	writeLong(long offset, long l) Writes a 64-bit signed integer to the buffer at the given offset.
T	writeMedium(long offset, int m) Writes a 24-bit signed integer to the buffer at the given offset.
T	writeShort(long offset, short s) Writes a 16-bit signed integer to the buffer at the given offset.
T	writeString(long offset, String s) Writes a string to the buffer at the given offset.
T	writeUnsignedByte(long offset, int b) Writes an unsigned byte to the buffer at the given position.
T	writeUnsignedInt(long offset, long i) Writes a 32-bit unsigned integer to the buffer at the given offset.
T	writeUnsignedMedium(long offset, int m) Writes a 24-bit unsigned integer to the buffer at the given offset.
T	writeUnsignedShort(long offset, int s) Writes a 16-bit unsigned integer to the buffer at the given offset.
T	writeUTF8(long offset, String s) Writes a UTF-8 string to the buffer at the given offset.
T	zero() Zeros out all bytes in the array.
T	zero(long offset) Zeros out all bytes starting at the given offset in the array.
T	zero(long offset, long length) Zeros out bytes starting at the given offset up to the given length.

Method Detail

zero

T zero()

Zeros out all bytes in the array.

Returns:

The written bytes.

zero

T zero(long offset)

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

T zero(long offset,
       long length)

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.

write

T write(long offset,
        Bytes src,
        long srcOffset,
        long length)

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

T write(long offset,
        byte[] src,
        long srcOffset,
        long length)

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

T writeByte(long offset,
            int b)

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

T writeUnsignedByte(long offset,
                    int b)

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

T writeChar(long offset,
            char c)

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

T writeShort(long offset,
             short s)

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

T writeUnsignedShort(long offset,
                     int s)

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

T writeMedium(long offset,
              int m)

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

T writeUnsignedMedium(long offset,
                      int m)

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

T writeInt(long offset,
           int i)

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

T writeUnsignedInt(long offset,
                   long i)

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

T writeLong(long offset,
            long l)

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

T writeFloat(long offset,
             float f)

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

T writeDouble(long offset,
              double d)

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

T writeBoolean(long offset,
               boolean b)

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

T writeString(long offset,
              String s)

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

T writeUTF8(long offset,
            String s)

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

T flush()

Flushes the bytes to the underlying persistence layer.

Returns:

The flushed buffer.