org.jets3t.service.io

Class InterruptableInputStream

java.lang.Object

java.io.InputStream

org.jets3t.service.io.InterruptableInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, InputStreamWrapper

public class InterruptableInputStream
extends java.io.InputStream
implements InputStreamWrapper

Input stream wrapper that allows the underlying wrapped input stream to be interrupted. Every time a blocking stream operation is invoked on this class, the interrupt flag is checked first. If this flag is set, the underlying stream is closed and an IOException "Input Stream Interrupted" is thrown.

Note: This hacky class does not really solve the problem of interrupting blocking Java input streams, as it cannot unblock a blocked read operation. It really just serves as a convenient way to interrupt streams before any potentially blocking operations.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.InputStream	inputStream
private boolean	interrupted
private static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
InterruptableInputStream(java.io.InputStream inputStream)

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
java.io.InputStream	getWrappedInputStream()
void	interrupt()
boolean	markSupported()
private void	maybeInterruptInputStream()
int	read()
int	read(byte[] b, int off, int len)
void	reset()

Methods inherited from class java.io.InputStream

mark, read, skip

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

inputStream

private java.io.InputStream inputStream

interrupted

private boolean interrupted

Constructor Detail

InterruptableInputStream

public InterruptableInputStream(java.io.InputStream inputStream)

Method Detail

maybeInterruptInputStream

private void maybeInterruptInputStream()
                                throws java.io.IOException

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

getWrappedInputStream

public java.io.InputStream getWrappedInputStream()

Specified by:

getWrappedInputStream in interface InputStreamWrapper

Returns:

the underlying input stream wrapped by this class.

interrupt

public void interrupt()