javax.servlet: abstract public class: ServletInputStream

javax.servlet
abstract public class: ServletInputStream [javadoc | source]

java.lang.Object
   java.io.InputStream
      javax.servlet.ServletInputStream

All Implemented Interfaces:
Closeable

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. With some protocols, such as HTTP POST and PUT, a ServletInputStream object can be used to read data sent from the client.

A ServletInputStream object is normally retrieved via the ServletRequest#getInputStream method.

This is an abstract class that a servlet container implements. Subclasses of this class must implement the java.io.InputStream.read() method.

Also see:

ServletRequest

author: Various -

version: $ - Version$

Constructor:
protected ServletInputStream() { } Does nothing, because this is an abstract class.

Constructor:

 protected ServletInputStream() {

}

Does nothing, because this is an abstract class.

Method from javax.servlet.ServletInputStream Summary:
readLine

Methods from java.io.InputStream:
available, close, mark, markSupported, read, read, read, reset, skip

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.servlet.ServletInputStream Detail:
public int readLine(byte[] b, int off, int len) throws IOException { if (len < = 0) { return 0; } int count = 0, c; while ((c = read()) != -1) { b[off++] = (byte)c; count++; if (c == '\n' \|\| count == len) { break; } } return count > 0 ? count : -1; } Reads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a certain number of bytes or reaches a newline character, which it reads into the array as well. This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.

Method from javax.servlet.ServletInputStream Detail:

 public int readLine(byte[] b,
    int off,
    int len) throws IOException {
	if (len < = 0) {
	    return 0;
	}
	int count = 0, c;
	while ((c = read()) != -1) {
	    b[off++] = (byte)c;
	    count++;
	    if (c == '\n' || count == len) {
		break;
	    }
	}
	return count  > 0 ? count : -1;
}

This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.