Package ro.sync.ecss.extensions.api.webapp.plugin.servlet

Class ServletInputStream

java.lang.Object

java.io.InputStream

ro.sync.ecss.extensions.api.webapp.plugin.servlet.ServletInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public abstract class ServletInputStream
extends InputStream

ServletInputStream interface inspired from HTTP Servlet 5.0.

Since:

26

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletInputStream()	Does nothing, because this is an abstract class.

Method Summary

Modifier and Type	Method	Description
final int	readLine(byte[] b, int off, int len)	Reads the input stream, one line at a time.

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, because this is an abstract class.

Method Details

readLine

public final int readLine(byte[] b,
 int off,
 int len)
                   throws IOException

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 read

off - an integer specifying the character at which this method begins reading

len - 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:

IOException - if an input or output exception has occurred