Package com.saperion.common.io

Class SerializableInputStream

java.lang.Object

java.io.InputStream

com.saperion.common.io.SerializableInputStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class SerializableInputStream
extends InputStream
implements Serializable

An InputStream that is serializable

Author:

jschwarz

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BUFFER_SIZE
static final int	DEFAULT_IN_MEMORY_BYTES
static final int	END_OF_STREAM

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SerializableInputStream()
	SerializableInputStream(InputStream inputStream)	Creates a SerializableInputStream for a given underlying InputStream
	SerializableInputStream(InputStream in, int bufferSize, int inMemoryBytes, File tempFileDirectory)	Creates a SerializableInputStream for a given underlying InputStream

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
InputStream	getInputStream()	This method returns the wrapped input stream that is serialized by this stream.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
static Iterable<byte[]>	readChunksFromObjectStream(ObjectInputStream inputStream)	This method expects the given ObjectInputStream to hold the data of an InputStream serialized by writeStreamAsChunksToObjectStream(InputStream, int, ObjectOutputStream) and returns an Iterable for the serialized chunks of the stream.
void	reset()
long	skip(long n)
static void	writeStreamAsChunksToObjectStream(InputStream inputStream, int chunkSize, ObjectOutputStream outputStream)	This method serializes a given InputStream to a given ObjectOutputStream.

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

• Constant Field Values

DEFAULT_IN_MEMORY_BYTES

public static final int DEFAULT_IN_MEMORY_BYTES

See Also:

• Constant Field Values

END_OF_STREAM

public static final int END_OF_STREAM

See Also:

• Constant Field Values

Constructor Details

SerializableInputStream

protected SerializableInputStream()

SerializableInputStream

public SerializableInputStream(InputStream inputStream)

Creates a SerializableInputStream for a given underlying InputStream

Parameters:

inputStream - the underlying input stream. Must not be null.

SerializableInputStream

public SerializableInputStream(InputStream in,
 int bufferSize,
 int inMemoryBytes,
 File tempFileDirectory)

Creates a SerializableInputStream for a given underlying InputStream

Parameters:

in - the underlying input stream. Must not be null.

bufferSize - the size of the chunks used for serialization

inMemoryBytes - number of bytes to keep in memory before using a temp file when deserializing the stream

tempFileDirectory - directory to store temporary files in when deserializing the stream

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

getInputStream

public InputStream getInputStream()

This method returns the wrapped input stream that is serialized by this stream.

Returns:

the wrapped input stream that is serialized by this stream

writeStreamAsChunksToObjectStream

public static void writeStreamAsChunksToObjectStream(InputStream inputStream,
 int chunkSize,
 ObjectOutputStream outputStream)
                                              throws IOException

This method serializes a given InputStream to a given ObjectOutputStream.

Parameters:

inputStream - the stream to serialize

chunkSize - the size of the chunks the stream is serialized as

outputStream - the output stream to serialize to

Throws:

IOException

readChunksFromObjectStream

public static Iterable<byte[]> readChunksFromObjectStream(ObjectInputStream inputStream)

This method expects the given ObjectInputStream to hold the data of an InputStream serialized by writeStreamAsChunksToObjectStream(InputStream, int, ObjectOutputStream) and returns an Iterable for the serialized chunks of the stream.

NOTE: be aware that for performance reasons the Iterator returned by the iterable will return the same byte array for most chunks. So if it is necessary - for whatever reason - to store the chunks one needs to copy them first

Parameters:

inputStream - an object input stream holding the data of an InputStream serialized by writeStreamAsChunksToObjectStream(InputStream, int, ObjectOutputStream)

Returns:

an Iterable for the serialized chunks of the stream