Package org.apache.jackrabbit.vault.util

Class InputStreamPump

java.lang.Object

java.io.InputStream

org.apache.jackrabbit.vault.util.InputStreamPump

All Implemented Interfaces:

Closeable, AutoCloseable

public class InputStreamPump
extends InputStream

An input stream pump feeds a InputStreamPump.Pump in a dedicated thread with the input read from the given input stream. This is similar to a TeeInputStream but leverages PipedInputStream and PipedOutputStream and can execute additional tasks in the additional thread consuming the PipedInputStream. Only after calling close() the PipedInputStream has been fully consumed (as it waits for the pump's thread to complete).

See Also:

MemoryArchive

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputStreamPump.Pump

Constructor Summary

Constructors

Constructor	Description
InputStreamPump(InputStream source, InputStreamPump.Pump pump)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
Exception	getError()	Deprecated. Rather call close(), as otherwise this might be called too early (before the thread finished).
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamPump

public InputStreamPump(InputStream source,
                       InputStreamPump.Pump pump)
                throws IOException

Throws:

IOException

Method Detail

getError

@Deprecated
public Exception getError()

Deprecated.

Rather call close(), as otherwise this might be called too early (before the thread finished). close() will automatically wrap the potential exception from the pump in an IOException and throws it as well

Returns:

exception which has occurred in the pump thread or null.

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