org.archive.streamcontext

Class AbstractBufferingStream

java.lang.Object

org.archive.streamcontext.AbstractBufferingStream

All Implemented Interfaces:

Closeable, AutoCloseable, Stream

Direct Known Subclasses:

ByteArrayWrappedStream, HDFSStream, HTTP11Stream, RandomAccessFileStream, SimpleStream

public abstract class AbstractBufferingStream
extends Object
implements Stream

Class which implements the bulk of the functionality needed for Stream behavior, leaving concrete subclasses to implement only 3 simple methods beyond their constructors: doSeek() doRead() doClose() This class maintains a buffer of bytes read, and attempts to be efficient about seeks within that buffer.

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	atEof
protected byte[]	buffer
protected int	bufferCursor
protected int	bufferRemaining
protected boolean	closed
protected static int	DEFAULT_READ_SIZE
protected long	offset

Constructor Summary

Constructors

Constructor and Description
AbstractBufferingStream()
AbstractBufferingStream(long offset)
AbstractBufferingStream(long offset, int readSize)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	atEof()
void	close()
abstract void	doClose()
abstract int	doRead(byte[] b, int off, int len)
abstract void	doSeek(long offset)
long	getOffset()
int	read(byte[] b, int off, int len)
long	setOffset(long newOffset)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_READ_SIZE

protected static int DEFAULT_READ_SIZE

offset

protected long offset

closed

protected boolean closed

atEof

protected boolean atEof

buffer

protected byte[] buffer

bufferRemaining

protected int bufferRemaining

bufferCursor

protected int bufferCursor

Constructor Detail

AbstractBufferingStream

public AbstractBufferingStream()

AbstractBufferingStream

public AbstractBufferingStream(long offset)

AbstractBufferingStream

public AbstractBufferingStream(long offset,
                       int readSize)

Method Detail

doRead

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

Throws:

IOException

doSeek

public abstract void doSeek(long offset)
                     throws IOException

Throws:

IOException

doClose

public abstract void doClose()
                      throws IOException

Throws:

IOException

atEof

public boolean atEof()

Specified by:

atEof in interface Stream

getOffset

public long getOffset()

Specified by:

getOffset in interface Stream

read

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

Specified by:

read in interface Stream

Throws:

IOException

setOffset

public long setOffset(long newOffset)
               throws IOException

Specified by:

setOffset in interface Stream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException