Name
ServletInputStream
Synopsis
Class Name: javax.servlet.ServletInputStream
Superclass: java.io.InputStream
Immediate Subclasses: None
Interfaces Implemented: None
Availability: Servlet API 1.0 and later
Description
Provides an input stream for reading binary data from a client
request, including an efficient readLine()
method
for reading data one line at a time. A
ServletInputStream
is returned by the
getInputStream()
method of
ServletRequest
. A servlet that filters binary
output from other sources generally gets its input via this stream.
Class Summary
public abstract class ServletInputStream extends java.io.InputStream { // Constructors protected ServletInputStream(); // Instance Methods public int readLine(byte b[], int off, int len) throws IOException; }
Constructors
ServletInputStream()
protected ServletInputStream()
- Description
The default constructor does nothing. Because servlets rarely, if ever, create their own input streams, it can be safely ignored.
Instance Methods
readLine()
public int readLine(byte b[], int off, int len) throws IOException
- Description
Reads bytes from the input stream into the byte array
b
, starting at an offset in the array given byoff
. It stops reading when it encounters an'\n'
or it has readlen
number of bytes. The ending'\n'
character is read into the buffer as well. Returns the number of bytes read, or-1
if the end of the stream is reached.
Get Java Servlet Programming now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.