GrepCode: javax.servlet.ServletInputStream (.java) - Class

Maven-Central
/
javax.servlet / servlet-api
/
2.4

3.0-alpha-1
2.5
2.4
2.3
2.2
/
javax.servlet.ServletInputStream
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
 Copyright 2003-2004 The Apache Software Foundation

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
16
17
18
//
19
// This source code implements specifications defined by the Java
20
// Community Process. In order to remain compliant with the specification
21
// DO NOT add / change / or delete method signatures!
22
//
23
24
package javax.servlet;
25
26
import java.io.IOException;
27
import java.io.InputStream;


 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.

 
 Version:$Rev: 46019 $ $Date: 2004-09-14 04:56:06 -0500 (Tue, 14 Sep 2004) $ See also:ServletRequest
47
48
public abstract class ServletInputStream extends InputStream {
    
 Does nothing, because this is an abstract class.
 
51
52
    protected ServletInputStream() {
53
    }

    
 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.

 
 Parameters:b an array of bytes into which data is readoff an integer specifying the character at which
 this method begins readinglen an integer specifying the maximum number of
 bytes to read Returns:an integer specifying the actual number of bytes
 read, or -1 if the end of the stream is reached Throws:java.io.IOException if an input or output exception has occurred
76
77
    public int readLine(byte[] b, int off, int len) throws IOException {
78
        if (len <= 0) {
79
            return 0;
80
        }
81
        int count = 0, c;
82
83
        while ((c = read()) != -1) {
84
            b[off++] = (byte) c;
85
            count++;
86
            if (c == '\n' || count == len) {
87
                break;
88
            }
89
        }
90
        return count > 0 ? count : -1;
91
    }
92
}