Class ServletInputStream

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class ServletInputStream
extends InputStream

This class serves as a stream where servlets can read data supplied by the client from.

Since:

Servlet API 1.0

Version:

Servlet API 2.2

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletInputStream()	Does nothing.

Method Summary

Modifier and Type	Method	Description
int	readLine(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, nullInputStream, read, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ServletInputStream

protected ServletInputStream()

Does nothing.

Since:

Servlet API 1.0

Method Details

readLine

public int readLine(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 offset into the buffer and attempts to read until a end of line ('\n') is encountered or length bytes are read. 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.

Parameters:

buffer - The array into which the bytes read should be stored

offset - The offset into the array to start storing bytes

length - The maximum number of bytes to read

Returns:

The actual number of bytes read, or -1 if end of stream.

Throws:

IOException - If an error occurs.

Since:

Servlet API 1.0