de.unkrig.commons.io

Class Writers

java.lang.Object

de.unkrig.commons.io.Writers

public final class Writers
extends Object

Utility functionality related to Writers.

Field Summary

Fields

Modifier and Type	Field and Description
static Writer	DISCARD A writer that ignores any data written to it.

Method Summary

Modifier and Type	Method and Description
static Writer	autoFlushing(Writer out)
static Writer	fromAppendable(Appendable delegate) Wraps an Appendable as a Writer (if necessary).
static Writer	onFirstChar(Writer out, Runnable runnable)
static Writer	tee(Writer... delegates) Creates and returns a Writer that delegates all work to the given delegates: The write() methods write the given data to all the delegates; if any of these throw an IOException, it is rethrown, and it is undefined whether all the data was written to all the delegates.
static Writer	trackLineAndColumn(Writer out, LineUtil.LineAndColumnTracker tracker)

Methods inherited from class java.lang.Object

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

Field Detail

DISCARD

public static final Writer DISCARD

A writer that ignores any data written to it.

Method Detail

fromAppendable

public static Writer fromAppendable(Appendable delegate)

Wraps an Appendable as a Writer (if necessary).

onFirstChar

public static Writer onFirstChar(Writer out,
                                 Runnable runnable)

Returns:

A FilterWriter that runs the runnable right before the first character is written

trackLineAndColumn

public static Writer trackLineAndColumn(Writer out,
                                        LineUtil.LineAndColumnTracker tracker)

Returns:

A FilterWriter that tracks line and column numbers while characters are written

See Also:

LineUtil.lineAndColumnTracker()

tee

public static Writer tee(Writer... delegates)

Creates and returns a Writer that delegates all work to the given delegates:

• The write() methods write the given data to all the delegates; if any of these throw an IOException, it is rethrown, and it is undefined whether all the data was written to all the delegates.
• flush() flushes the delegates; throws the first IOException that any of the delegates throws.
• close() attempts to close all the delegates; if any of these throw IOExceptions, one of them is rethrown.

autoFlushing

public static Writer autoFlushing(Writer out)

Returns:

A Writer that forwards all write() and append() operations to out, and flushes out after each write() or append() operation