org.apache.commons.httpclient
Class ChunkedOutputStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--org.apache.commons.httpclient.ChunkedOutputStream

public class ChunkedOutputStream

extends java.io.OutputStream

Wrapper supporting the chunked transfer encoding.

Since:

2.0

Version:

$Revision: 1.10 $ $Date: 2003/04/19 22:29:31 $

Author:

Remy Maucherat, Sean C. Sullivan, dIon Gillard, Oleg Kalnichevski, Mike Bowler

See Also:

ChunkedInputStream

Constructor Summary

ChunkedOutputStream(java.io.OutputStream stream)
Construct an output stream wrapping the given stream.

Method Summary

void	close() Close this output stream, causing any buffered data to be flushed and any further output data to throw an IOException.
void	flush() Flushes the underlying stream.
void	print(java.lang.String s) Writes a String to the client, without a carriage return line feed (CRLF) character at the end.
void	println() Writes a carriage return-line feed (CRLF) to the client.
void	println(java.lang.String s) Writes a String to the client, followed by a carriage return-line feed (CRLF).
void	write(byte[] b, int off, int len) Write the specified byte array.
void	write(int b) Write the specified byte to our output stream.
void	writeClosingChunk() Close this output stream, causing any buffered data to be flushed and any further output data to throw an IOException.

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(java.io.OutputStream stream)

Construct an output stream wrapping the given stream. The stream will not use chunking.

Parameters:

stream - wrapped output stream. Must be non-null.

Method Detail

print

public void print(java.lang.String s)
           throws java.io.IOException

Writes a String to the client, without a carriage return line feed (CRLF) character at the end. The platform default encoding is used!

Parameters:

s - the String to send to the client. Must be non-null.

Throws:

java.io.IOException - if an input or output exception occurred

println

public void println()
             throws java.io.IOException

Writes a carriage return-line feed (CRLF) to the client.

Throws:

java.io.IOException - if an input or output exception occurred

println

public void println(java.lang.String s)
             throws java.io.IOException

Writes a String to the client, followed by a carriage return-line feed (CRLF).

Parameters:

s - the String to write to the client

Throws:

java.io.IOException - if an input or output exception occurred

write

public void write(int b)
           throws java.io.IOException,
                  java.lang.IllegalStateException

Write the specified byte to our output stream.

Specified by:

write in class java.io.OutputStream

Parameters:

b - The byte to be written

Throws:

java.io.IOException - if an input/output error occurs

java.lang.IllegalStateException - if stream already closed

write

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

Write the specified byte array.

Overrides:

write in class java.io.OutputStream

Parameters:

b - the byte array to write out

off - the offset within b to start writing from

len - the length of data within b to write

Throws:

java.io.IOException - when errors occur writing output

writeClosingChunk

public void writeClosingChunk()
                       throws java.io.IOException

Close this output stream, causing any buffered data to be flushed and any further output data to throw an IOException. The underlying stream is not closed!

Throws:

java.io.IOException - if an error occurs closing the stream

flush

public void flush()
           throws java.io.IOException

Flushes the underlying stream.

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException - If an IO problem occurs.

close

public void close()
           throws java.io.IOException

Close this output stream, causing any buffered data to be flushed and any further output data to throw an IOException. The underlying stream is not closed!

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - if an error occurs closing the stream