com.mware.ge.csv

Class ThreadAheadReadable

java.lang.Object

java.lang.Thread

com.mware.ge.csv.ThreadAhead

com.mware.ge.csv.ThreadAheadReadable

All Implemented Interfaces:

CharReadable, SourceTraceability, Closeable, AutoCloseable, Runnable

public class ThreadAheadReadable
extends ThreadAhead
implements CharReadable

Like an ordinary CharReadable, it's just that the reading happens in a separate thread, so when a consumer wants to read(SectionedCharBuffer, int) more data it's already available, merely a memcopy away.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Nested classes/interfaces inherited from interface com.mware.ge.csv.CharReadable

CharReadable.Adapter

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface com.mware.ge.csv.CharReadable

EMPTY

Method Summary

Modifier and Type	Method and Description
long	length()
long	position()
int	read(char[] into, int offset, int length) Reads characters into the given array starting at offset, reading length number of characters.
SectionedCharBuffer	read(SectionedCharBuffer buffer, int from) The one calling read doesn't actually read, since reading is up to the thread in here.
protected boolean	readAhead()
String	sourceDescription()
static CharReadable	threadAhead(CharReadable actual, int bufferSize)

Methods inherited from class com.mware.ge.csv.ThreadAhead

assertHealthy, close, parkAWhile, pokeReader, run, waitUntilReadAhead

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Method Detail

read

public SectionedCharBuffer read(SectionedCharBuffer buffer,
                                int from)
                         throws IOException

The one calling read doesn't actually read, since reading is up to the thread in here. Instead the caller just waits for this thread to have fully read the next buffer and flips over to that buffer, returning it.

Specified by:

read in interface CharReadable

Parameters:

buffer - SectionedCharBuffer to read new data into.

from - index into the buffer array where characters to save (compact) starts (inclusive).

Returns:

a SectionedCharBuffer containing new data.

Throws:

IOException - if an I/O error occurs.

read

public int read(char[] into,
                int offset,
                int length)

Description copied from interface: CharReadable

Reads characters into the given array starting at offset, reading length number of characters. Similar to Reader.read(char[], int, int)

Specified by:

read in interface CharReadable

Parameters:

into - char[] to read the data into.

offset - offset to start reading into the char[].

length - number of bytes to read maximum.

Returns:

number of bytes read, or 0 if there were no bytes read and end of readable is reached.

readAhead

protected boolean readAhead()
                     throws IOException

Specified by:

readAhead in class ThreadAhead

Throws:

IOException

position

public long position()

Specified by:

position in interface SourceTraceability

Returns:

a low-level byte-like position e.g. byte offset.

sourceDescription

public String sourceDescription()

Specified by:

sourceDescription in interface SourceTraceability

Returns:

description of the source being read from.

threadAhead

public static CharReadable threadAhead(CharReadable actual,
                                       int bufferSize)

length

public long length()

Specified by:

length in interface CharReadable

Returns:

length of this source, in bytes.