de.unkrig.commons.io

Class ConsumingWriter

java.lang.Object

java.io.Writer

de.unkrig.commons.io.ConsumingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ConsumingWriter
extends Writer

A Writer which transfers the character stream to a Consumer.

When the returned writer is flushed or closed, then the consumer is invoked with an empty char sequence, which tells it to "flush itself". This is relevant for stateful consumers.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
ConsumingWriter(ConsumerWhichThrows<? super CharSequence,? extends IOException> consumer)

Method Summary

Modifier and Type	Method and Description
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
void	close()
static Writer	create(ConsumerWhichThrows<? super CharSequence,? extends IOException> consumer) This method is sometimes more efficient than calling "new ConsumingWriter()".
void	flush()
void	write(char[] cbuf, int off, int len)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

append, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumingWriter

public ConsumingWriter(ConsumerWhichThrows<? super CharSequence,? extends IOException> consumer)

Method Detail

create

public static Writer create(ConsumerWhichThrows<? super CharSequence,? extends IOException> consumer)

This method is sometimes more efficient than calling "new ConsumingWriter()".

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq,
                     int start,
                     int end)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException