de.jarnbjo.jsnappy

Class SnzMTInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

de.jarnbjo.jsnappy.SnzInputStream

de.jarnbjo.jsnappy.SnzMTInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SnzMTInputStream
extends SnzInputStream

Alternative to SnzInputStream with support for multi-threaded decomression.

By default, SnzMTInputStream will use a default ThreadPoolExecutor with a core size set to the number of available CPUs and a maximum size of twice the number of available CPUs. The threads used yby the default executor will be started as daemon threads. The default executor is not created until actually requried and can be queried and replaced with the static getDefaultExecutor and setDefaultExecutor methods.

Since:

1.0

Author:

Tor-Einar Jarnbjo

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
SnzMTInputStream(InputStream in) Creates an input stream, which reads from the specified input and uses the default executor.
SnzMTInputStream(InputStream in, Executor executor) Creates an input stream, which reads from the specified input and uses the provided executor instead of the default executor.

Method Summary

Methods

Modifier and Type	Method and Description
static Executor	getDefaultExecutor() Returns the default executor or null if no default executor has been created yet.
int	read(byte[] b, int off, int len) Fills the byte array with data from the uncompressed stream starting at the specified offset and no more than length bytes.
static void	setDefaultExecutor(Executor executor) Sets a new default executor.

Methods inherited from class de.jarnbjo.jsnappy.SnzInputStream

getBlockSize, read, read

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SnzMTInputStream

public SnzMTInputStream(InputStream in)

Creates an input stream, which reads from the specified input and uses the default executor.

Parameters:

in -

SnzMTInputStream

public SnzMTInputStream(InputStream in,
                Executor executor)

Creates an input stream, which reads from the specified input and uses the provided executor instead of the default executor.

Parameters:

in -

executor -

Method Detail

read

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

Description copied from class: SnzInputStream

Fills the byte array with data from the uncompressed stream starting at the specified offset and no more than length bytes.

Overrides:

read in class SnzInputStream

Parameters:

b - destination array

off - offset into the byte array, on which the data is written

Returns:

the number of bytes read or -1 if end of stream is reached

Throws:

IOException

getDefaultExecutor

public static Executor getDefaultExecutor()

Returns the default executor or null if no default executor has been created yet.

Returns:

the default executor

setDefaultExecutor

public static void setDefaultExecutor(Executor executor)

Sets a new default executor.

Setting a new default executor will have no effect on already created instances of this class. Setting the default executor to null will cause a new default executor to be created when needed.

Note that replacing a running executor will not cause the previous default executor to be automatically shut down.

Parameters:

executor - a new default executor