gnu.java.net.protocol.http

Class ChunkedInputStream

Implemented Interfaces:
AutoCloseable, Closeable

public class ChunkedInputStream
extends InputStream

Input stream wrapper for the "chunked" transfer-coding.

Constructor Summary

ChunkedInputStream(InputStream in, gnu.java.net.protocol.http.Headers headers)
Constructor.

Method Summary

int
available()
This method returns the number of bytes that can be read from this stream before a read might block.
void
close()
This method closes the ChunkedInputStream by closing the underlying InputStream.
int
read()
This method reads an unsigned byte from the input stream and returns it as an int in the range of 0-255.
int
read(byte[] buffer, int offset, int length)
This method read bytes from a stream and stores them into a caller supplied buffer.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChunkedInputStream

public ChunkedInputStream(InputStream in,
                          gnu.java.net.protocol.http.Headers headers)
Constructor.
Parameters:
in - the response socket input stream
headers - the headers to receive additional header lines

Method Details

available

public int available()
            throws IOException
This method returns the number of bytes that can be read from this stream before a read might block. Even if the underlying InputStream has data available past the end of the current chunk, we have no way of knowing how large the next chunk header will be. So we cannot report available data past the current chunk.
Overrides:
available in interface InputStream
Returns:
The number of bytes that can be read before a read might block
Throws:
IOException - If an error occurs

close

public void close()
            throws IOException
This method closes the ChunkedInputStream by closing the underlying InputStream.
Specified by:
close in interface Closeable
close in interface AutoCloseable
Overrides:
close in interface InputStream
Throws:
IOException - If an error occurs

read

public int read()
            throws IOException
This method reads an unsigned byte from the input stream and returns it as an int in the range of 0-255. This method also will return -1 if the end of the stream has been reached.

This method will block until the byte can be read.

Overrides:
read in interface InputStream
Returns:
The byte read or -1 if end of stream
Throws:
IOException - If an error occurs

read

public int read(byte[] buffer,
                int offset,
                int length)
            throws IOException
This method read bytes from a stream and stores them into a caller supplied buffer. It starts storing the data at index off into the buffer and attempts to read len bytes. This method can return before reading the number of bytes requested. The actual number of bytes read is returned as an int. A -1 is returned to indicate the end of the stream.

This method will block until some data can be read.

This method operates by calling the single byte read() method in a loop until the desired number of bytes are read. The read loop stops short if the end of the stream is encountered or if an IOException is encountered on any read operation except the first. If the first attempt to read a bytes fails, the IOException is allowed to propagate upward. And subsequent IOException is caught and treated identically to an end of stream condition. Subclasses can (and should if possible) override this method to provide a more efficient implementation.

Overrides:
read in interface InputStream
Parameters:
Returns:
The actual number of bytes read, or -1 if end of stream.
Throws:
IOException - If an error occurs.

ChunkedInputStream.java -- Copyright (C) 2004, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.