javax.servlet

Class ServletInputStream

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class ServletInputStream
extends java.io.InputStream

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

Since:

1.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServletInputStream() Does nothing.

Method Summary

Methods

Modifier and Type	Method and Description
int	readLine(byte[] buffer, int offset, int length) Reads bytes using the InputStream.read() method until it reaches the limit, EOF or an LF character (which will also be placed in the array).

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServletInputStream

protected ServletInputStream()

Does nothing.

Method Detail

readLine

public int readLine(byte[] buffer,
           int offset,
           int length)
             throws java.io.IOException

Reads bytes using the InputStream.read() method until it reaches the limit, EOF or an LF character (which will also be placed in the array). Returns -1 if EOF is reached.

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:

java.io.IOException - If an error occurs.