io.atomix.catalyst.buffer

Interface BufferOutput<T extends BufferOutput<?>>

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Buffer

All Known Implementing Classes:

AbstractBuffer, DirectBuffer, FileBuffer, HeapBuffer, MappedBuffer, NativeBuffer, OutputStreamBufferOutput, ReadOnlyBuffer, SlicedBuffer, SwappedBuffer

public interface BufferOutput<T extends BufferOutput<?>>
extends AutoCloseable

Writable buffer.

This interface exposes methods for writing to a byte buffer. Writable buffers maintain a small amount of state regarding current cursor positions and limits similar to the behavior of ByteBuffer.

Author:

Jordan Halterman

Method Summary

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

Method Detail

write

T write(Bytes bytes)

Writes an array of bytes to the buffer.

Parameters:

bytes - The array of bytes to write.

Returns:

The written buffer.

write

T write(byte[] bytes)

Writes an array of bytes to the buffer.

Parameters:

bytes - The array of bytes to write.

Returns:

The written buffer.

write

T write(Bytes bytes,
        long offset,
        long length)

Writes an array of bytes to the buffer.

Parameters:

bytes - The array of bytes to write.

offset - The offset at which to start writing the bytes.

length - The number of bytes from the provided byte array to write to the buffer.

Returns:

The written buffer.

write

T write(byte[] bytes,
        long offset,
        long length)

Writes an array of bytes to the buffer.

Parameters:

bytes - The array of bytes to write.

offset - The offset at which to start writing the bytes.

length - The number of bytes from the provided byte array to write to the buffer.

Returns:

The written buffer.

write

T write(Buffer buffer)

Writes a buffer to the buffer.

Parameters:

buffer - The buffer to write.

Returns:

The written buffer.

writeByte

T writeByte(int b)

Writes a byte to the buffer.

Parameters:

b - The byte to write.

Returns:

The written buffer.

writeUnsignedByte

T writeUnsignedByte(int b)

Writes an unsigned byte to the buffer.

Parameters:

b - The byte to write.

Returns:

The written buffer.

writeChar

T writeChar(char c)

Writes a 16-bit character to the buffer.

Parameters:

c - The character to write.

Returns:

The written buffer.

writeShort

T writeShort(short s)

Writes a 16-bit signed integer to the buffer.

Parameters:

s - The short to write.

Returns:

The written buffer.

writeUnsignedShort

T writeUnsignedShort(int s)

Writes a 16-bit unsigned integer to the buffer.

Parameters:

s - The short to write.

Returns:

The written buffer.

writeMedium

T writeMedium(int m)

Writes a 24-bit signed integer to the buffer.

Parameters:

m - The integer to write.

Returns:

The written buffer.

writeUnsignedMedium

T writeUnsignedMedium(int m)

Writes a 24-bit unsigned integer to the buffer.

Parameters:

m - The integer to write.

Returns:

The written buffer.

writeInt

T writeInt(int i)

Writes a 32-bit signed integer to the buffer.

Parameters:

i - The integer to write.

Returns:

The written buffer.

writeUnsignedInt

T writeUnsignedInt(long i)

Writes a 32-bit unsigned integer to the buffer.

Parameters:

i - The integer to write.

Returns:

The written buffer.

writeLong

T writeLong(long l)

Writes a 64-bit signed integer to the buffer.

Parameters:

l - The long to write.

Returns:

The written buffer.

writeFloat

T writeFloat(float f)

Writes a single-precision 32-bit floating point number to the buffer.

Parameters:

f - The float to write.

Returns:

The written buffer.

writeDouble

T writeDouble(double d)

Writes a double-precision 64-bit floating point number to the buffer.

Parameters:

d - The double to write.

Returns:

The written buffer.

writeBoolean

T writeBoolean(boolean b)

Writes a 1 byte boolean to the buffer.

Parameters:

b - The boolean to write.

Returns:

The written buffer.

writeString

T writeString(String s)

Writes a string to the buffer.

Parameters:

s - The string to write.

Returns:

The written buffer.

writeUTF8

T writeUTF8(String s)

Writes a UTF-8 string to the buffer.

Parameters:

s - The string to write.

Returns:

The written buffer.

flush

T flush()

Flushes the buffer to the underlying persistence layer.

Returns:

The flushed buffer.

close

void close()

Specified by:

close in interface AutoCloseable