org.spf4j.io

Class MemorizingBufferedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.spf4j.io.MemorizingBufferedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@ParametersAreNonnullByDefault
 @CleanupObligation
public final class MemorizingBufferedInputStream
extends FilterInputStream

Why another buffered input stream? Main use case if for troubleshooting. Allows you to get more detail on where your stream processing failed. Implementation is a circular byte buffer, where you have 2 sizes to control the behavior: buffer size - the total sie of the buffer. read size - the maximum number of read bytes kept in the buffer.

Author:

zoly

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
MemorizingBufferedInputStream(InputStream in)
MemorizingBufferedInputStream(InputStream in, Charset charset)
MemorizingBufferedInputStream(InputStream in, int size)
MemorizingBufferedInputStream(InputStream in, int size, int readSize, SizedRecyclingSupplier<byte[]> bufferProvider, Charset charset)

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
long	getReadBytes()
byte[]	getReadBytesFromBuffer()
byte[]	getUnreadBytesFromBuffer()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Constructor Detail

MemorizingBufferedInputStream

public MemorizingBufferedInputStream(InputStream in)

MemorizingBufferedInputStream

public MemorizingBufferedInputStream(InputStream in,
                                     int size)

MemorizingBufferedInputStream

public MemorizingBufferedInputStream(InputStream in,
                                     Charset charset)

MemorizingBufferedInputStream

public MemorizingBufferedInputStream(InputStream in,
                                     int size,
                                     int readSize,
                                     SizedRecyclingSupplier<byte[]> bufferProvider,
                                     @Nullable
                                     Charset charset)

Method Detail

close

@DischargesObligation
public void close()
                                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException

getReadBytesFromBuffer

public byte[] getReadBytesFromBuffer()

getUnreadBytesFromBuffer

public byte[] getUnreadBytesFromBuffer()

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getReadBytes

public long getReadBytes()

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

reset

public void reset()

Overrides:

reset in class FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream