org.stekikun.dolmen.common

Class CountingWriter

java.lang.Object

java.io.Writer

org.stekikun.dolmen.common.CountingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CountingWriter
extends Writer

Implementation of Writer which delegates all operations to an underlying instance of Writer, but counts the characters that are written to the stream along the way. The current count of characters can be retrieved with getCount().

Author:

Stéphane Lescuyer

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CountingWriter(Writer out) Creates a writer wrapping out which counts the number of characters written into it.

Method Summary

Modifier and Type	Method and Description
CountingWriter	append(char c)
CountingWriter	append(@Nullable CharSequence csq)
CountingWriter	append(@Nullable CharSequence csq, int start, int end)
void	close()
void	flush()
long	getCount()
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(@Nullable String str)
void	write(@Nullable String str, int off, int len)

Methods inherited from class java.lang.Object

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

Constructor Detail

CountingWriter

public CountingWriter(Writer out)

Creates a writer wrapping out which counts the number of characters written into it. It will of course not take into account the characters which have already been written to out, or those which may be written to out directly in the future (i.e. by keeping a reference to out and using it outside of this class, which of course is really not recommended).

Parameters:

out -

Method Detail

getCount

public long getCount()

Returns:

the number of characters written into this instance since its creation

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Specified by:

write in class Writer

Throws:

IOException

write

public void write(@Nullable String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Overrides:

write in class Writer

Throws:

IOException

append

public CountingWriter append(@Nullable CharSequence csq)
                      throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public CountingWriter append(@Nullable CharSequence csq,
                             int start,
                             int end)
                      throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public CountingWriter append(char c)
                      throws IOException

Specified by:

append in interface Appendable

Overrides:

append 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