org.apache.axiom.om.util

Class DetachableInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.axiom.om.util.DetachableInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DetachableInputStream
extends java.io.FilterInputStream

FilterInputStream that delegates to the original InputStream. When detach() is called, the original InputStream is consumed, and closed. The unread bytes are stored in a local stream. Subsequent requests are serviced by the local stream. Rationale: The detached stream can be closed and its resources freed, but the consumer of the stream can continue to receive data. Cons: If there are a lot of bytes remaining, these are buffered. Currently they are buffered incore (this could be improved to buffer in a file).

Field Summary

Fields

Modifier and Type	Field and Description
private long	count
(package private) boolean	isClosed
(package private) BAAInputStream	localStream
private static org.apache.commons.logging.Log	log

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
DetachableInputStream(java.io.InputStream in)

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	detach() Consume the input stream and close it.
long	length()
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)
private static java.lang.String	stackToString(java.lang.Throwable e)

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

count

private long count

localStream

BAAInputStream localStream

isClosed

boolean isClosed

Constructor Detail

DetachableInputStream

public DetachableInputStream(java.io.InputStream in)

Method Detail

length

public long length()
            throws java.io.IOException

Returns:

count of bytes read

Throws:

java.io.IOException

detach

public void detach()
            throws java.io.IOException

Consume the input stream and close it. The bytes in the input stream are buffered. (Thus the original input stream can release its resources, but the consumer of the stream can still receive data).

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.FilterInputStream

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.FilterInputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.FilterInputStream

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.FilterInputStream

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.FilterInputStream

Throws:

java.io.IOException

stackToString

private static java.lang.String stackToString(java.lang.Throwable e)