Package com.atlassian.confluence.util.io

Class CharacterCountingWriter

java.lang.Object

java.io.Writer

com.atlassian.confluence.util.io.CharacterCountingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

@NotThreadSafe
public class CharacterCountingWriter
extends Writer

A Writer which delegates to another Writer, and counts the number of characters that gets written to the delegate.

The resulting count is only reliable if no exceptions get thrown by any of the methods.

Since:

5.8

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
CharacterCountingWriter(Writer delegate)

Method Summary

Modifier and Type	Method	Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
void	close()
void	flush()
long	getCharacterCount()
void	write(@org.checkerframework.checker.nullness.qual.NonNull char[] cbuf)
void	write(@org.checkerframework.checker.nullness.qual.NonNull char[] cbuf, int off, int len)
void	write(int c)
void	write(@NonNull String str)
void	write(@NonNull String str, int off, int len)

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Constructor Details

CharacterCountingWriter

public CharacterCountingWriter(Writer delegate)

Method Details

getCharacterCount

public long getCharacterCount()

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(@org.checkerframework.checker.nullness.qual.NonNull char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(@org.checkerframework.checker.nullness.qual.NonNull char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(@NonNull String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Overrides:

write 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

append

public Writer 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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException