de.unkrig.commons.io

Class Readers

java.lang.Object

de.unkrig.commons.io.Readers

public final class Readers
extends Object

Utility functionality related to Readers.

Field Summary

Fields

Modifier and Type	Field and Description
static Reader	EMPTY_READER A reader that always signals "end-of-input".

Method Summary

Modifier and Type	Method and Description
static Reader	asReader(CharSequence cs) Wraps the given CharSequence in a Reader - much more efficient than "new StringReader(cs.toString)".
static Reader	onFirstChar(Reader in, Runnable runnable)
static String	readAll(Reader reader)
static String	readAll(Reader reader, boolean closeReader)
static int	readFully(Reader in, char[] buffer, int offset, int len)
static Reader	singlingFilterReader(Reader delegate)
static Reader	trackLineAndColumn(Reader in, LineUtil.LineAndColumnTracker tracker)
static Reader	wye(Reader in, Writer out) Creates and returns a Reader that duplicates all chars read from in and writes them to out.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_READER

public static final Reader EMPTY_READER

A reader that always signals "end-of-input".

Method Detail

readFully

public static int readFully(Reader in,
                            char[] buffer,
                            int offset,
                            int len)
                     throws IOException

Throws:

IOException

readAll

public static String readAll(Reader reader)
                      throws IOException

Returns:

All characters that the given Reader produces

Throws:

IOException

readAll

public static String readAll(Reader reader,
                             boolean closeReader)
                      throws IOException

Parameters:

closeReader - Whether the reader should be closed before the method returns

Returns:

All characters that the given Reader produces

Throws:

IOException

asReader

public static Reader asReader(CharSequence cs)

Wraps the given CharSequence in a Reader - much more efficient than "new StringReader(cs.toString)".

singlingFilterReader

public static Reader singlingFilterReader(Reader delegate)

Returns:

A Reader for which Reader.read(char[], int, int) returns at most 1

onFirstChar

public static Reader onFirstChar(Reader in,
                                 Runnable runnable)

Returns:

FilterReader that runs the runnable right before the first character is read

trackLineAndColumn

public static Reader trackLineAndColumn(Reader in,
                                        LineUtil.LineAndColumnTracker tracker)

Returns:

A FilterReader that tracks line and column numbers while characters are being read

See Also:

LineUtil.lineAndColumnTracker()

wye

public static Reader wye(Reader in,
                         Writer out)

Creates and returns a Reader that duplicates all chars read from in and writes them to out.

Out is never flushed automatically; if you want to have that, you must flush out yourself.

Reader.close() closes in but does not flush nor close out.