com.clarkparsia.modularity.io

Class UncloseableOutputStream

java.lang.Object

java.io.OutputStream

com.clarkparsia.modularity.io.UncloseableOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class UncloseableOutputStream
extends OutputStream

Title:

Description:

Copyright: Copyright (c) 2009

Company: Clark & Parsia, LLC.

A wrapper around the underlying stream that prevents the underlying stream from being closed (if passed to other methods that are not very nice and close your stream). The initial motivation for this wrapper was ZipOutputStream where you write into multiple separate entries; some methods (which are not aware that they write to a ZipOutputStream) when they finish writing their data they close the stream, which terminates the whole process of producing the zip file.

Author:

Blazej Bulka

Constructor Summary

Constructors

Constructor and Description
UncloseableOutputStream(OutputStream stream) Wraps an output stream with a wrapper that does not allow the underlying stream to be closed.

Method Summary

Modifier and Type	Method and Description
void	close() Captures the close request, and does NOT forward it to the underlying stream.
void	flush() Forwards the call to the underlying stream.
OutputStream	getUnderlyingStream() Gets the underlying stream.
void	write(byte[] b) Forwards the call to the underlying stream.
void	write(byte[] b, int off, int len) Forwards the call to the underlying stream.
void	write(int b) Forwards the call to the underlying stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

UncloseableOutputStream

public UncloseableOutputStream(OutputStream stream)

Wraps an output stream with a wrapper that does not allow the underlying stream to be closed.

Parameters:

stream - the underlying stream to be protected from closing.

Method Detail

close

public void close()

Captures the close request, and does NOT forward it to the underlying stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

flush

public void flush()
           throws IOException

Forwards the call to the underlying stream.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Forwards the call to the underlying stream.

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Forwards the call to the underlying stream.

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Forwards the call to the underlying stream.

Specified by:

write in class OutputStream

Throws:

IOException

getUnderlyingStream

public OutputStream getUnderlyingStream()

Gets the underlying stream. This method may be useful to actually close the underlying stream, when all the calls are finished.

Returns:

the underlying stream.