org.neo4j.csv.reader

Interface CharReadable

All Superinterfaces:

AutoCloseable, Closeable, SourceTraceability

All Known Implementing Classes:

CharReadable.Adapter, MultiReadable, ThreadAheadReadable

public interface CharReadable
extends Closeable, SourceTraceability

A Readable, but focused on char[], via a SectionedCharBuffer with one of the main reasons that Reader.read(CharBuffer) creates a new char[] as big as the data it's about to read every call. However Reader.read(char[], int, int) doesn't, and so leaves no garbage. The fact that this is a separate interface means that Readable instances need to be wrapped, but that's fine since the buffer size should be reasonably big such that read(SectionedCharBuffer, int) isn't called too often. Therefore the wrapping overhead should not be noticeable at all. Also took the opportunity to let CharReadable extends Closeable, something that Readable doesn't.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CharReadable.Adapter

Field Summary

Fields inherited from interface org.neo4j.csv.reader.SourceTraceability

EMPTY

Method Summary

Modifier and Type	Method and Description
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) Reads characters into the buffer.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.neo4j.csv.reader.SourceTraceability

lineNumber, position, sourceDescription

Method Detail

read

SectionedCharBuffer read(SectionedCharBuffer buffer,
                         int from)
                  throws IOException

Reads characters into the buffer. This method will block until data is available, an I/O error occurs, or the end of the stream is reached. The caller is responsible for passing in from which index existing characters should be saved, using compaction, before reading into the front section of the buffer, using SectionedCharBuffer.readFrom(Reader). The returned SectionedCharBuffer can be the same as got passed in, or another buffer if f.ex. double-buffering is used. If this reader reached eof, i.e. equal state to that of Reader.read(char[]) returning -1 then SectionedCharBuffer.hasAvailable() for the returned instances will return false.

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

int read(char[] into,
         int offset,
         int length)
  throws IOException

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

Throws:

IOException