com.mware.ge.csv

Class Readables

java.lang.Object

com.mware.ge.csv.Readables

public class Readables
extends Object

Means of instantiating common CharReadable instances. There are support for compressed files as well for those methods accepting a File argument.

1. ZIP: is both an archive and a compression format. In many cases the order of files is important and for a ZIP archive with multiple files, the order of the files are whatever the order set by the tool that created the ZIP archive. Therefore only single-file-zip files are supported. The single file in the given ZIP archive will be decompressed on the fly, while reading.
2. GZIP: is only a compression format and so will be decompressed on the fly, while reading.

Field Summary

Fields

Modifier and Type	Field and Description
static CharReadable	EMPTY

Method Summary

Modifier and Type	Method and Description
static char[]	extractFirstLineFrom(CharReadable source) Extracts the first line, i.e characters until the first newline or end of stream.
static CharReadable	files(Charset charset, File... files)
static RawIterator<CharReadable,IOException>	individualFiles(Charset charset, File... files)
static <IN,OUT> RawIterator<OUT,IOException>	iterator(ThrowingFunction<IN,OUT,IOException> converter, IN... items)
static CharReadable	wrap(InputStream stream, String sourceName, Charset charset)
static CharReadable	wrap(InputStream stream, String sourceName, Charset charset, long length) Wraps a InputStream in a CharReadable.
static CharReadable	wrap(Reader reader, long length) Wraps a Reader in a CharReadable.
static CharReadable	wrap(String data)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final CharReadable EMPTY

Method Detail

wrap

public static CharReadable wrap(InputStream stream,
                                String sourceName,
                                Charset charset)
                         throws IOException

Throws:

IOException

wrap

public static CharReadable wrap(InputStream stream,
                                String sourceName,
                                Charset charset,
                                long length)
                         throws IOException

Wraps a InputStream in a CharReadable.

Parameters:

stream - Reader to wrap.

sourceName - name or description of the source of the stream.

charset - Charset to use for reading.

length - total number of bytes provided by the reader.

Returns:

a CharReadable for the Reader.

Throws:

IOException - on I/O error.

wrap

public static CharReadable wrap(String data)

wrap

public static CharReadable wrap(Reader reader,
                                long length)

Wraps a Reader in a CharReadable. Remember that the Object.toString() must provide a description of the data source.

Parameters:

reader - Reader to wrap.

length - total number of bytes provided by the reader.

Returns:

a CharReadable for the Reader.

individualFiles

public static RawIterator<CharReadable,IOException> individualFiles(Charset charset,
                                                                    File... files)

files

public static CharReadable files(Charset charset,
                                 File... files)
                          throws IOException

Throws:

IOException

iterator

@SafeVarargs
public static <IN,OUT> RawIterator<OUT,IOException> iterator(ThrowingFunction<IN,OUT,IOException> converter,
                                                                          IN... items)

extractFirstLineFrom

public static char[] extractFirstLineFrom(CharReadable source)
                                   throws IOException

Extracts the first line, i.e characters until the first newline or end of stream. Reads one character at a time to be sure not to read too far ahead. The stream is left in a state of either exhausted or at the beginning of the next line of data.

Parameters:

source - CharReadable to read from.

Returns:

char[] containing characters until the first newline character or end of stream.

Throws:

IOException - on I/O reading error.