Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> http >> [ io overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.http.io
Class ContentLengthOutputStream  

java.lang.Object
  java.io.OutputStream
      org.apache.http.io.ContentLengthOutputStream

---

public class ContentLengthOutputStream

extends java.io.OutputStream

A stream wrapper that closes itself after a defined number of bytes.

Since:

4.0

Version:

$Revision: 390883 $

---

Field Summary
private  boolean	closed           True if the stream is closed.
private  long	contentLength           The maximum number of bytes that can be written the stream.
private  HttpDataTransmitter	out           Wrapped data transmitter that all calls are delegated to.
private  long	total           Total bytes written

 

Constructor Summary

ContentLengthOutputStream(HttpDataTransmitter out, long contentLength)           Creates a new length limited stream

 

Method Summary
void	close()           Does not close the underlying socket output.
void	flush()           This method forces any data that may have been buffered to be written to the underlying output device.
void	write(byte[] b)           This method all the writes bytes from the passed array to the output stream.
void	write(byte[] b, int off, int len)           This method writes len bytes from the specified array b starting at index off into the array.
void	write(int b)           This method writes a single byte to the output stream.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

out

private final HttpDataTransmitter out

Wrapped data transmitter that all calls are delegated to.

---

contentLength

private final long contentLength

The maximum number of bytes that can be written the stream. Subsequent write operations will be ignored.

---

total

private long total

Total bytes written

---

closed

private boolean closed

True if the stream is closed.

Constructor Detail

ContentLengthOutputStream

public ContentLengthOutputStream(HttpDataTransmitter out,
                                 long contentLength)

Creates a new length limited stream

Since:

4.0

Method Detail

close

public void close()
           throws java.io.IOException

Does not close the underlying socket output.

---

flush

public void flush()
           throws java.io.IOException

Description copied from class: java.io.OutputStream

This method forces any data that may have been buffered to be written to the underlying output device. Please note that the host environment might perform its own buffering unbeknowst to Java. In that case, a write made (for example, to a disk drive) might be cached in OS buffers instead of actually being written to disk.

This method in this class does nothing.

---

write

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

Description copied from class: java.io.OutputStream

This method writes len bytes from the specified array b starting at index off into the array.

This method in this class calls the single byte write() method in a loop until all bytes have been written. Subclasses should override this method if possible in order to provide a more efficent implementation.

---

write

public void write(byte[] b)
           throws java.io.IOException

Description copied from class: java.io.OutputStream

This method all the writes bytes from the passed array to the output stream. This method is equivalent to write(b, 0, buf.length) which is exactly how it is implemented in this class.

---

write

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

Description copied from class: java.io.OutputStream

This method writes a single byte to the output stream. The byte written is the low eight bits of the int passed and a argument.

Subclasses must provide an implementation of this abstract method

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> http >> [ io overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---