public abstract class AbstractServletInputStream extends ServletInputStream
| Modifier and Type | Field and Description |
|---|---|
protected static StringManager |
sm |
| Constructor and Description |
|---|
AbstractServletInputStream() |
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
protected abstract void |
doClose() |
protected abstract boolean |
doIsReady() |
protected abstract int |
doRead(boolean block,
byte[] b,
int off,
int len)
Abstract method to be overridden by concrete implementations.
|
boolean |
isFinished()
Has the end of this InputStream been reached?
|
boolean |
isReady()
Can data be read from this InputStream without blocking?
|
protected void |
onAllDataRead() |
protected void |
onError(Throwable t) |
int |
read() |
int |
read(byte[] b,
int off,
int len) |
int |
readLine(byte[] b,
int off,
int len)
Reads the input stream, one line at a time.
|
void |
setReadListener(ReadListener listener)
Sets the
ReadListener for this ServletInputStream and
thereby switches to non-blocking IO. |
available, mark, markSupported, read, reset, skipprotected static final StringManager sm
public final boolean isFinished()
javax.servlet.ServletInputStreamisFinished in class ServletInputStreamtrue if all the data has been read from the stream,
else falsepublic final boolean isReady()
javax.servlet.ServletInputStreamReadListener.onDataAvailable() when data is available.isReady in class ServletInputStreamtrue if data can be read without blocking, else
falsepublic final void setReadListener(ReadListener listener)
javax.servlet.ServletInputStreamReadListener for this ServletInputStream and
thereby switches to non-blocking IO. It is only valid to switch to
non-blocking IO within async processing or HTTP upgrade processing.setReadListener in class ServletInputStreamlistener - The non-blocking IO read listenerpublic final int read()
throws IOException
read in class InputStreamIOExceptionpublic final int readLine(byte[] b,
int off,
int len)
throws IOException
javax.servlet.ServletInputStreamThis method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.
readLine in class ServletInputStreamb - 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 readIOException - if an input or output exception has occurredpublic final int read(byte[] b,
int off,
int len)
throws IOException
read in class InputStreamIOExceptionpublic void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableclose in class InputStreamIOExceptionprotected final void onAllDataRead()
throws IOException
IOExceptionprotected final void onError(Throwable t)
protected abstract boolean doIsReady()
throws IOException
IOExceptionprotected abstract int doRead(boolean block,
byte[] b,
int off,
int len)
throws IOException
IOExceptionprotected abstract void doClose()
throws IOException
IOExceptionCopyright © 2000-2015 Apache Software Foundation. All Rights Reserved.