net.markenwerk.utils.data.fetcher

Class AbstractDataFetcher

java.lang.Object

net.markenwerk.utils.data.fetcher.AbstractDataFetcher

All Implemented Interfaces:

DataFetcher

Direct Known Subclasses:

AbstractBufferedDataFetcher

public abstract class AbstractDataFetcher
extends Object
implements DataFetcher

AbstractDataFetcher is a sensible base implementation of DataFetcher.

Implementers must only implement a single simplified method that copies all bytes from an InputStream to an OutputStream: doCopy(InputStream, OutputStream, DataFetchProgressListener).

Since:

4.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractDataFetcher()

Method Summary

Modifier and Type	Method and Description
void	copy(InputStream in, OutputStream out) Copies the content of a given InputStream into a given OutputStream.
void	copy(InputStream in, OutputStream out, boolean closeIn, boolean closeOut) Copies the content of a given InputStream into a given OutputStream.
void	copy(InputStream in, OutputStream out, DataFetchProgressListener listener) Copies the content of a given InputStream into a given OutputStream.
void	copy(InputStream in, OutputStream out, DataFetchProgressListener listener, boolean closeIn, boolean closeOut) Copies the content of a given InputStream into a given OutputStream.
protected abstract void	doCopy(InputStream in, OutputStream out, DataFetchProgressListener listener) Copies the content of a given InputStream into a given OutputStream.
byte[]	fetch(InputStream in) Fetches the content of a given InputStream into a fresh byte[].
byte[]	fetch(InputStream in, boolean close) Fetches the content of a given InputStream into a fresh byte[].
byte[]	fetch(InputStream in, DataFetchProgressListener listener) Fetches the content of a given InputStream into a fresh byte[].
byte[]	fetch(InputStream in, DataFetchProgressListener listener, boolean close) Fetches the content of a given InputStream into a fresh byte[].

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataFetcher

public AbstractDataFetcher()

Method Detail

fetch

public final byte[] fetch(InputStream in)
                   throws DataFetchException

Description copied from interface: DataFetcher

Fetches the content of a given InputStream into a fresh byte[].

See DataFetcher.copy(InputStream, OutputStream, boolean, boolean) for the handling of missing or invalid arguments.

Specified by:

fetch in interface DataFetcher

Parameters:

in - The InputStream to read from.

Returns:

A new byte[], containing the content of the given InputStream.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream.

fetch

public final byte[] fetch(InputStream in,
                          boolean close)
                   throws DataFetchException

Description copied from interface: DataFetcher

Fetches the content of a given InputStream into a fresh byte[].

See DataFetcher.copy(InputStream, OutputStream, boolean, boolean) for the handling of missing or invalid arguments.

Specified by:

fetch in interface DataFetcher

Parameters:

in - The InputStream to read from.

close - Whether to close the given InputStream, after reading from it.

Returns:

A new byte[], containing the content of the given InputStream.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream. FetchExceptions thrown while trying to close the given InputStream, if requested, are ignored.

fetch

public final byte[] fetch(InputStream in,
                          DataFetchProgressListener listener)
                   throws DataFetchException

Description copied from interface: DataFetcher

Fetches the content of a given InputStream into a fresh byte[].

See DataFetcher.copy(InputStream, OutputStream, boolean, boolean) for the handling of missing or invalid arguments.

Specified by:

fetch in interface DataFetcher

Parameters:

in - The InputStream to read from.

listener - The DataFetchProgressListener to report to.

Returns:

A new byte[], containing the content of the given InputStream.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream.

fetch

public final byte[] fetch(InputStream in,
                          DataFetchProgressListener listener,
                          boolean close)
                   throws DataFetchException

Description copied from interface: DataFetcher

Fetches the content of a given InputStream into a fresh byte[].

See DataFetcher.copy(InputStream, OutputStream, boolean, boolean) for the handling of missing or invalid arguments.

Specified by:

fetch in interface DataFetcher

Parameters:

in - The InputStream to read from.

listener - The DataFetchProgressListener to report to.

close - Whether to close the given InputStream, after reading from it.

Returns:

A new byte[], containing the content of the given InputStream.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream. FetchExceptions thrown while trying to close the given InputStream, if requested, are ignored.

copy

public final void copy(InputStream in,
                       OutputStream out)
                throws DataFetchException

Description copied from interface: DataFetcher

Copies the content of a given InputStream into a given OutputStream.

See DataFetcher.copy(InputStream, OutputStream, boolean, boolean) for the handling of missing or invalid arguments.

Specified by:

copy in interface DataFetcher

Parameters:

in - The InputStream to read from.

out - The OutputStream to write to.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream or writing to the given OutputStream.

copy

public final void copy(InputStream in,
                       OutputStream out,
                       boolean closeIn,
                       boolean closeOut)
                throws DataFetchException

Description copied from interface: DataFetcher

Copies the content of a given InputStream into a given OutputStream.

Missing or invalid arguments are handled gracefully with the following behaviour.

A null is given as an InputStream, it is simply ignored and handled as if there was nothing to read. If closeOut is true, the given OutputStream will be closed anyway

A null is given as an OutputStream, it is simply ignored, but the content of given InputStream is fetched anyway. If closeIn is true, the given InputStream will be closed anyway

Specified by:

copy in interface DataFetcher

Parameters:

in - The InputStream to read from.

out - The OutputStream to write to.

closeIn - Whether to close the given InputStream, after reading from it.

closeOut - Whether to close the given OutputStream, after writing to it.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream or writing to the given OutputStream. FetchExceptions thrown while trying to close one of the given streams, if requested, are ignored.

copy

public final void copy(InputStream in,
                       OutputStream out,
                       DataFetchProgressListener listener)
                throws DataFetchException

Description copied from interface: DataFetcher

Copies the content of a given InputStream into a given OutputStream.

See DataFetcher.copy(InputStream, OutputStream, boolean, boolean) for the handling of missing or invalid arguments.

Specified by:

copy in interface DataFetcher

Parameters:

in - The InputStream to read from.

out - The OutputStream to write to.

listener - The DataFetchProgressListener to report to.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream or writing to the given OutputStream.

copy

public final void copy(InputStream in,
                       OutputStream out,
                       DataFetchProgressListener listener,
                       boolean closeIn,
                       boolean closeOut)
                throws DataFetchException

Description copied from interface: DataFetcher

Copies the content of a given InputStream into a given OutputStream.

Missing or invalid arguments are handled gracefully with the following behaviour.

A null is given as an InputStream, it is simply ignored and handled as if there was nothing to read. If closeOut is true, the given OutputStream will be closed anyway

A null is given as an OutputStream, it is simply ignored, but the content of given InputStream is fetched anyway. If closeIn is true, the given InputStream will be closed anyway

Specified by:

copy in interface DataFetcher

Parameters:

in - The InputStream to read from.

out - The OutputStream to write to.

listener - The DataFetchProgressListener to report to.

closeIn - Whether to close the given InputStream, after reading from it.

closeOut - Whether to close the given OutputStream, after writing to it.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream or writing to the given OutputStream. FetchExceptions thrown while trying to close one of the given streams, if requested, are ignored.

doCopy

protected abstract void doCopy(InputStream in,
                               OutputStream out,
                               DataFetchProgressListener listener)
                        throws DataFetchException

Copies the content of a given InputStream into a given OutputStream.

It is guaranteed that neither the given InputStream nor the given OutputStream nor the given DataFetchProgressListener is null.

Implementers must not close either of the given streams.

Parameters:

in - The InputStream to read from.

out - The OutputStream to write to.

listener - The DataFetchProgressListener to report to.

Throws:

DataFetchException - If anything went wrong while reading from the given InputStream or writing to the given OutputStream.