Package com.helger.commons.io.stream

Class LoggingWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.helger.commons.io.stream.WrappedWriter

com.helger.commons.io.stream.LoggingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class LoggingWriter
extends WrappedWriter

A wrapper around an Writer that logs what he is doing.

Since:

9.3.8

Author:

Philip Helger

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
LoggingWriter(Writer aSourceReader)

Method Summary

Modifier and Type	Method	Description
void	close()
long	getBytesWritten()
protected void	onClose(long nTotalBytesWritten)
protected void	onWrite(int nBytesWritten, long nTotalBytesWritten)
String	toString()
void	write(char[] aBuf, int nOfs, int nLen)
void	write(int b)

Methods inherited from class com.helger.commons.io.stream.WrappedWriter

getWrappedWriter

Methods inherited from class java.io.FilterWriter

flush, write

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingWriter

public LoggingWriter(@Nonnull
                     Writer aSourceReader)

Parameters:

aSourceReader - The writer that should be logged. May not be null.

Method Detail

getBytesWritten

@Nonnegative
public final long getBytesWritten()

Returns:

The number of written bytes. Always ≥ 0.

onWrite

@OverrideOnDemand
protected void onWrite(@Nonnegative
                       int nBytesWritten,
                       long nTotalBytesWritten)

onClose

@OverrideOnDemand
protected void onClose(long nTotalBytesWritten)

write

public final void write(int b)
                 throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public final void write(@Nonnull
                        char[] aBuf,
                        int nOfs,
                        int nLen)
                 throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

close

public final void close()
                 throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterWriter

Throws:

IOException

toString

public String toString()

Overrides:

toString in class WrappedWriter