Package com.helger.commons.io.stream

Class LoggingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.helger.commons.io.stream.WrappedOutputStream

com.helger.commons.io.stream.LoggingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class LoggingOutputStream
extends WrappedOutputStream

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

Author:

Philip Helger

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
LoggingOutputStream(OutputStream aSourceOS)

Method Summary

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

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

getWrappedOutputStream

Methods inherited from class java.io.FilterOutputStream

flush, write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingOutputStream

public LoggingOutputStream(@Nonnull
 OutputStream aSourceOS)

Parameters:

aSourceOS - The output stream that should be logged. May not be null.

Method Details

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 FilterOutputStream

Throws:

IOException

write

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

Overrides:

write in class WrappedOutputStream

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 FilterOutputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class WrappedOutputStream