serguei.http

Class ChunkedOutputStream

java.lang.Object

java.io.OutputStream

serguei.http.ChunkedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ChunkedOutputStream
extends OutputStream

Output stream that produces chunked transfer encoded output. Depending on creation parameters, the underlying stream might be left open after calling close() method of this class. This is to allow, in case this stream was in turn wrapped with a different stream to be left open even when close() was called (e.g. we have to call close() on GZIPOutputStream to finish off the process while we might want a connection to stay open).

Author:

Serguei Poliakov

Constructor Summary

Constructors

Constructor and Description
ChunkedOutputStream(OutputStream outputStream) Create a new instance of ChunkedOutputStream by wrapping around OutputStream The underlying output stream will be left open if we call close() on this instance
ChunkedOutputStream(OutputStream outputStream, boolean leaveUnderlyingStreamOpen) Create a new instance of ChunkedOutputStream by wrapping around OutputStream
ChunkedOutputStream(OutputStream outputStream, int chunkSize) Create a new instance of ChunkedOutputStream by wrapping around OutputStream The underlying output stream will be left open if we call close() on this instance
ChunkedOutputStream(OutputStream outputStream, int chunkSize, boolean leaveUnderlyingStreamOpen) Create a new instance of ChunkedOutputStream by wrapping around OutputStream

Method Summary

Modifier and Type	Method and Description
void	close() This finishes write by writing last chunk and then, if the instance was created with parameter leaveUnderlyingStreamOpen set to false, closes the underlying stream, otherwise it flushes it and leave opened
void	flush()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkedOutputStream

public ChunkedOutputStream(OutputStream outputStream)

Create a new instance of ChunkedOutputStream by wrapping around OutputStream The underlying output stream will be left open if we call close() on this instance

Parameters:

outputStream - - stream to wrap

ChunkedOutputStream

public ChunkedOutputStream(OutputStream outputStream,
                           int chunkSize)

Create a new instance of ChunkedOutputStream by wrapping around OutputStream The underlying output stream will be left open if we call close() on this instance

Parameters:

outputStream - - stream to wrap

chunkSize - - size of a chunk

ChunkedOutputStream

public ChunkedOutputStream(OutputStream outputStream,
                           boolean leaveUnderlyingStreamOpen)

Create a new instance of ChunkedOutputStream by wrapping around OutputStream

Parameters:

outputStream - - stream to wrap

leaveUnderlyingStreamOpen - - if true when close() is called the outputStream is flushed, but not closed

ChunkedOutputStream

public ChunkedOutputStream(OutputStream outputStream,
                           int chunkSize,
                           boolean leaveUnderlyingStreamOpen)

Create a new instance of ChunkedOutputStream by wrapping around OutputStream

Parameters:

outputStream - - stream to wrap

chunkSize - - size of a chunk

leaveUnderlyingStreamOpen - - if true when close() is called the outputStream is flushed, but not closed

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

This finishes write by writing last chunk and then, if the instance was created with parameter leaveUnderlyingStreamOpen set to false, closes the underlying stream, otherwise it flushes it and leave opened

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException