org.michailov.async.io

Class StringRingBuffer

java.lang.Object

org.michailov.async.io.RingBuffer

org.michailov.async.io.StringRingBuffer

public class StringRingBuffer
extends RingBuffer

This is a concrete implementation of RingBuffer of a String[].

Constructor Summary

Constructors

Constructor and Description
StringRingBuffer(int capacity) Constructs a ring buffer over an implicitly allocated String[].
StringRingBuffer(java.lang.String[] buffer) Constructs a ring buffer over an existing String[].

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getBuffer() Gets the underlying String[].
java.lang.String	peek(int delta) Gets the String at a given relative position ahead of the current virtual read position.
java.lang.String	read() Reads the String at the virtual read position, and advances the virtual read position by 1.
java.lang.String	write(java.lang.String s) Writes a String at the virtual write position, and advances the virtual write position by 1.

Methods inherited from class org.michailov.async.io.RingBuffer

advanceReadPosition, advanceWritePosition, getAvailableToRead, getAvailableToReadStraight, getAvailableToWrite, getAvailableToWriteStraight, getBufferLength, getReadPosition, getTotalReadCount, getTotalWriteCount, getWritePosition, isEOF, setEOF

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringRingBuffer

public StringRingBuffer(int capacity)

Constructs a ring buffer over an implicitly allocated String[].

Parameters:

capacity - Capacity of the implicit String[].

StringRingBuffer

public StringRingBuffer(java.lang.String[] buffer)

Constructs a ring buffer over an existing String[]. This overload is useful when the caller wants to reuse existing arrays to avoid unnecessary heap allocations.

Parameters:

buffer - An existing String[].

Method Detail

getBuffer

public java.lang.String[] getBuffer()

Gets the underlying String[]. This may be passed to buffer copying APIs along with RingBuffer.getAvailableToReadStraight() or RingBuffer.getAvailableToWriteStraight().

Returns:

The underlying String[].

peek

public java.lang.String peek(int delta)

Gets the String at a given relative position ahead of the current virtual read position.

Parameters:

delta - A relative position ahead of the virtual read position to peek at.

Returns:

The String at the peek position or null if delta is greater than RingBuffer.getAvailableToRead().

read

public java.lang.String read()

Reads the String at the virtual read position, and advances the virtual read position by 1.

Returns:

The String at the virtual read position or null if nothing is available to read.

write

public java.lang.String write(java.lang.String s)

Writes a String at the virtual write position, and advances the virtual write position by 1.

Parameters:

s - String to be written.

Returns:

The String that was written or null if no space was available to write.