Package net.markenwerk.utils.data.fetcher

Class BufferedDataFetcher

java.lang.Object

net.markenwerk.utils.data.fetcher.AbstractDataFetcher

net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher

net.markenwerk.utils.data.fetcher.BufferedDataFetcher

All Implemented Interfaces:

DataFetcher

public final class BufferedDataFetcher
extends AbstractBufferedDataFetcher

AbstractBufferedDataFetcher is a sensible base implementation of DataFetcher that uses a byte[] as buffer, while copying all bytes from an InputStream to an OutputStream by sequentially reading from the InputStream into the buffer and then writing from the buffer to the OutputStream.

The buffer is eagerly allocated in the constructor just once and then used for every operation. A BufferedDataFetcher is therefore not threadsafe.

After a buffer has been used, it is overwritten with zeros, to remove any buffered information from the memory.

Since:

4.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Field Summary

Fields inherited from class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher

DEFAULT_BUFEFR_SIZE

Constructor Summary

Constructors

Constructor	Description
BufferedDataFetcher()	Creates a new BufferedDataFetcher with the default buffer size of 1024 bytes.
BufferedDataFetcher(int bufferSize)	Creates a new BufferedDataFetcher with the given buffer size.

Method Summary

Modifier and Type	Method	Description
protected byte[]	obtainBuffer()	Called by AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) to obtain a byte[] to be used as a buffer.
protected void	returnBuffer(byte[] buffer)	Called by AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) to return a byte[] that has previously been obtained from AbstractBufferedDataFetcher.obtainBuffer().

Methods inherited from class net.markenwerk.utils.data.fetcher.AbstractBufferedDataFetcher

createBuffer, doCopy

Methods inherited from class net.markenwerk.utils.data.fetcher.AbstractDataFetcher

copy, copy, copy, copy, fetch, fetch, fetch, fetch

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedDataFetcher

public BufferedDataFetcher()

Creates a new BufferedDataFetcher with the default buffer size of 1024 bytes.

BufferedDataFetcher

public BufferedDataFetcher(int bufferSize)

Creates a new BufferedDataFetcher with the given buffer size.

Parameters:

bufferSize - The buffer size.

Method Detail

obtainBuffer

protected byte[] obtainBuffer()

Description copied from class: AbstractBufferedDataFetcher

Called by AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) to obtain a byte[] to be used as a buffer.

Every byte[] that is returned by this method will be passed as an argument of AbstractBufferedDataFetcher.returnBuffer(byte[]) after AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) has finished using it.

Specified by:

obtainBuffer in class AbstractBufferedDataFetcher

Returns:

The a byte[] to be used as a buffer.

returnBuffer

protected void returnBuffer(byte[] buffer)

Description copied from class: AbstractBufferedDataFetcher

Called by AbstractBufferedDataFetcher.doCopy(InputStream, OutputStream, DataFetchProgressListener) to return a byte[] that has previously been obtained from AbstractBufferedDataFetcher.obtainBuffer().

Specified by:

returnBuffer in class AbstractBufferedDataFetcher

Parameters:

buffer - The byte[] to be returned.