org.apache.camel.converter.stream

Class FileInputStreamCache

java.lang.Object

java.io.InputStream

org.apache.camel.converter.stream.FileInputStreamCache

All Implemented Interfaces:

Closeable, AutoCloseable, StreamCache

public final class FileInputStreamCache
extends InputStream
implements StreamCache

A StreamCache for Files

Field Summary

Fields inherited from interface org.apache.camel.StreamCache

DEFAULT_SPOOL_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
FileInputStreamCache(File file) Only for testing purposes.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
StreamCache	copy(Exchange exchange) Create a copy of the stream.
protected InputStream	getInputStream()
boolean	inMemory() Whether this StreamCache is in memory only or spooled to persistent storage such as files.
long	length() Gets the length of the cached stream.
int	read()
void	reset() Resets the StreamCache for a new stream consumption.
void	writeTo(OutputStream os) Writes the stream to the given output

Methods inherited from class java.io.InputStream

mark, markSupported, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInputStreamCache

public FileInputStreamCache(File file)
                     throws FileNotFoundException

Only for testing purposes.

Throws:

FileNotFoundException

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

reset

public void reset()

Description copied from interface: StreamCache

Resets the StreamCache for a new stream consumption.

Specified by:

reset in interface StreamCache

Overrides:

reset in class InputStream

writeTo

public void writeTo(OutputStream os)
             throws IOException

Description copied from interface: StreamCache

Writes the stream to the given output

Specified by:

writeTo in interface StreamCache

Parameters:

os - the destination to write to

Throws:

IOException - is thrown if write fails

copy

public StreamCache copy(Exchange exchange)
                 throws IOException

Description copied from interface: StreamCache

Create a copy of the stream. If possible use the same cached data in the copied instance.

This method is useful for parallel processing.

Implementations note: A copy of the stream is recommended to read from the start of the stream.

Specified by:

copy in interface StreamCache

Parameters:

exchange - exchange in which the stream cache object is used; can be used to delete resources of the stream cache when the exchange is completed

Returns:

a copy, or null if copy is not possible

Throws:

IOException - is thrown if the copy fails

inMemory

public boolean inMemory()

Description copied from interface: StreamCache

Whether this StreamCache is in memory only or spooled to persistent storage such as files.

Specified by:

inMemory in interface StreamCache

length

public long length()

Description copied from interface: StreamCache

Gets the length of the cached stream.

The implementation may return 0 in cases where the length cannot be computed, or if the implementation does not support this.

Specified by:

length in interface StreamCache

Returns:

number of bytes in the cache.

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

getInputStream

protected InputStream getInputStream()
                              throws IOException

Throws:

IOException