com.helger.commons.io.stream

Class LoggingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.helger.commons.io.stream.WrappedInputStream

com.helger.commons.io.stream.LoggingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class LoggingInputStream
extends WrappedInputStream

A wrapper around an InputStream that logs read and skip actions.

Author:

Philip Helger

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
LoggingInputStream(InputStream aSourceIS)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getPosition()
void	mark(int nReadlimit)
protected void	onClose(long nCurrentPosition)
protected void	onMark(int nReadLimit, long nCurrentPosition)
protected void	onRead(int nBytesRead, long nNewPosition)
protected void	onReset(long nCurrentPosition)
protected void	onSkip(long nBytesSkipped, long nNewPosition)
int	read()
int	read(byte[] aBuf, int nOffset, int nLength)
void	reset()
long	skip(long n)
String	toString()

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

getWrappedInputStream

Methods inherited from class java.io.FilterInputStream

available, markSupported, read

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingInputStream

public LoggingInputStream(@Nonnull
                          InputStream aSourceIS)

Parameters:

aSourceIS - The input stream to be logged. May not be null.

Method Detail

getPosition

public final long getPosition()

Returns:

The current read position. Always ≥ 0.

onRead

@OverrideOnDemand
protected void onRead(int nBytesRead,
                                         long nNewPosition)

onSkip

@OverrideOnDemand
protected void onSkip(long nBytesSkipped,
                                         long nNewPosition)

onMark

@OverrideOnDemand
protected void onMark(int nReadLimit,
                                         long nCurrentPosition)

onReset

@OverrideOnDemand
protected void onReset(long nCurrentPosition)

onClose

@OverrideOnDemand
protected void onClose(long nCurrentPosition)

read

public final int read()
               throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public final int read(byte[] aBuf,
                      int nOffset,
                      int nLength)
               throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public final long skip(@Nonnegative
                       long n)
                throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

mark

public final void mark(@Nonnegative
                       int nReadlimit)

Overrides:

mark in class FilterInputStream

reset

public final void reset()
                 throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class WrappedInputStream