Tomcat 10.1.19 · org.apache.catalina.connector.CoyoteReader

Modifier and Type	Field and Description
protected InputBuffer	ib
private static final char[]	LINE_SEP
protected char[]	lineBuffer
private static final int	MAX_LINE_LENGTH

Access	Constructor and Description
public	CoyoteReader(InputBuffer ib)

Method Summary

Modifier and Type	Method and Description
pack-priv void	clear() Clear facade.
protected Object	clone() Overrides java.lang.Object.clone. Prevent cloning the facade.
public void	close() Overrides java.io.BufferedReader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
public void	mark(int Limit on the number of characters that may be read while still preserving the mark. An attempt to reset the stream after reading characters up to this limit or beyond may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care. readAheadLimit) Overrides java.io.BufferedReader.mark. Marks the present position in the stream.
public boolean	markSupported() Overrides java.io.BufferedReader.markSupported. Tells whether this stream supports the mark() operation, which it does.
public int	read() Overrides java.io.BufferedReader.read. Reads a single character.
public int	read(char[] Destination buffer cbuf) Overrides java.io.Reader.read. Reads characters into an array.
public int	read(char[] Destination buffer cbuf, int Offset at which to start storing characters off, int Maximum number of characters to read len) Overrides java.io.BufferedReader.read. Reads characters into a portion of an array.
public String	readLine() Overrides java.io.BufferedReader.readLine. Reads a line of text.
public boolean	ready() Overrides java.io.BufferedReader.ready. Tells whether this stream is ready to be read.
public void	reset() Overrides java.io.BufferedReader.reset. Resets the stream to the most recent mark.
public long	skip(long The number of characters to skip n) Overrides java.io.BufferedReader.skip. Skips characters.

Inherited from java.io.BufferedReader:: lines

ib	back to summary
protected InputBuffer ib

LINE_SEP	back to summary
private static final char[] LINE_SEP

lineBuffer	back to summary
protected char[] lineBuffer

MAX_LINE_LENGTH	back to summary
private static final int MAX_LINE_LENGTH

CoyoteReader	back to summary
public CoyoteReader(InputBuffer ib)

Method Detail

clear	back to summary
pack-priv void clear() Clear facade.

clone back to summary

clone	back to summary
protected Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Prevent cloning the facade. Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: Doc from java.lang.Object.clone. if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

protected Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Prevent cloning the facade.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:

Doc from java.lang.Object.clone.

if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

close	back to summary
public void close() throws IOException Overrides java.io.BufferedReader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Overrides java.io.BufferedReader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

mark	back to summary
public void mark(int readAheadLimit) throws IOException Overrides java.io.BufferedReader.mark. Doc from java.io.BufferedReader.mark. Marks the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point. Parameters readAheadLimit:int Limit on the number of characters that may be read while still preserving the mark. An attempt to reset the stream after reading characters up to this limit or beyond may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care. Annotations @Override Exceptions IOException: If an I/O error occurs

mark

back to summary

public void mark(int readAheadLimit) throws IOException

Overrides java.io.BufferedReader.mark.

Doc from java.io.BufferedReader.mark.

Marks the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.

Parameters

readAheadLimit:int: Limit on the number of characters that may be read while still preserving the mark. An attempt to reset the stream after reading characters up to this limit or beyond may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

markSupported	back to summary
public boolean markSupported() Overrides java.io.BufferedReader.markSupported. Doc from java.io.BufferedReader.markSupported. Tells whether this stream supports the mark() operation, which it does. Returns:boolean Doc from java.io.Reader.markSupported. true if and only if this stream supports the mark operation. Annotations @Override

markSupported

back to summary

public boolean markSupported()

Overrides java.io.BufferedReader.markSupported.

Doc from java.io.BufferedReader.markSupported.

Tells whether this stream supports the mark() operation, which it does.

Returns:boolean

Doc from java.io.Reader.markSupported.

true if and only if this stream supports the mark operation.

Annotations

@Override

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.BufferedReader.read. Doc from java.io.BufferedReader.read. Reads a single character. Returns:int The character read, as an integer in the range 0 to 65535 (`0x00-0xffff`), or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public int read() throws IOException

Overrides java.io.BufferedReader.read.

Doc from java.io.BufferedReader.read.

Reads a single character.

Returns:int

The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf) throws IOException Overrides java.io.Reader.read. Doc from java.io.Reader.read. Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. If the length of `cbuf` is zero, then no characters are read and `0` is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value `-1` is returned; otherwise, at least one character is read and stored into `cbuf`. Parameters cbuf:char[] Destination buffer Returns:int The number of characters read, or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public int read(char[] cbuf) throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

If the length of cbuf is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters

cbuf:char[]: Destination buffer

Returns:int

The number of characters read, or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf, int off, int len) throws IOException Overrides java.io.BufferedReader.read. Doc from java.io.BufferedReader.read. Reads characters into a portion of an array. This method implements the general contract of the corresponding `read` method of the `Reader` class. As an additional convenience, it attempts to read as many characters as possible by repeatedly invoking the `read` method of the underlying stream. This iterated `read` continues until one of the following conditions becomes true: The specified number of characters have been read, The `read` method of the underlying stream returns `-1`, indicating end-of-file, or The `ready` method of the underlying stream returns `false`, indicating that further input requests would block. If the first `read` on the underlying stream returns `-1` to indicate end-of-file then this method returns `-1`. Otherwise this method returns the number of characters actually read. Subclasses of this class are encouraged, but not required, to attempt to read as many characters as possible in the same fashion. Ordinarily this method takes characters from this stream's character buffer, filling it from the underlying stream as necessary. If, however, the buffer is empty, the mark is not valid, and the requested length is at least as large as the buffer, then this method will read characters directly from the underlying stream into the given array. Thus redundant `BufferedReader`s will not copy data unnecessarily. Parameters cbuf:char[] Destination buffer off:int Offset at which to start storing characters len:int Maximum number of characters to read Returns:int The number of characters read, or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public int read(char[] cbuf, int off, int len) throws IOException

Overrides java.io.BufferedReader.read.

Doc from java.io.BufferedReader.read.

Reads characters into a portion of an array.

This method implements the general contract of the corresponding read method of the Reader class. As an additional convenience, it attempts to read as many characters as possible by repeatedly invoking the read method of the underlying stream. This iterated read continues until one of the following conditions becomes true:

The specified number of characters have been read,
The read method of the underlying stream returns -1, indicating end-of-file, or
The ready method of the underlying stream returns false, indicating that further input requests would block.

If the first read on the underlying stream returns -1 to indicate end-of-file then this method returns -1. Otherwise this method returns the number of characters actually read.

Subclasses of this class are encouraged, but not required, to attempt to read as many characters as possible in the same fashion.

Ordinarily this method takes characters from this stream's character buffer, filling it from the underlying stream as necessary. If, however, the buffer is empty, the mark is not valid, and the requested length is at least as large as the buffer, then this method will read characters directly from the underlying stream into the given array. Thus redundant BufferedReaders will not copy data unnecessarily.

Parameters

cbuf:char[]: Destination buffer
off:int: Offset at which to start storing characters
len:int: Maximum number of characters to read

Returns:int

The number of characters read, or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

readLine	back to summary
public String readLine() throws IOException Overrides java.io.BufferedReader.readLine. Doc from java.io.BufferedReader.readLine. Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), a carriage return followed immediately by a line feed, or by reaching the end-of-file (EOF). Returns:String A String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached without reading any characters Annotations @Override Exceptions IOException: If an I/O error occurs

readLine

back to summary

public String readLine() throws IOException

Overrides java.io.BufferedReader.readLine.

Doc from java.io.BufferedReader.readLine.

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), a carriage return followed immediately by a line feed, or by reaching the end-of-file (EOF).

Returns:String

A String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached without reading any characters

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

ready	back to summary
public boolean ready() throws IOException Overrides java.io.BufferedReader.ready. Doc from java.io.BufferedReader.ready. Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready. Returns:boolean Doc from java.io.Reader.ready. True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block. Annotations @Override Exceptions IOException: If an I/O error occurs

ready

back to summary

public boolean ready() throws IOException

Overrides java.io.BufferedReader.ready.

Doc from java.io.BufferedReader.ready.

Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.

Returns:boolean

Doc from java.io.Reader.ready.

True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

reset	back to summary
public void reset() throws IOException Overrides java.io.BufferedReader.reset. Doc from java.io.BufferedReader.reset. Resets the stream to the most recent mark. Annotations @Override Exceptions IOException: If the stream has never been marked, or if the mark has been invalidated

reset

back to summary

public void reset() throws IOException

Overrides java.io.BufferedReader.reset.

Doc from java.io.BufferedReader.reset.

Resets the stream to the most recent mark.

Annotations

@Override

Exceptions

IOException:: If the stream has never been marked, or if the mark has been invalidated

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.BufferedReader.skip. Doc from java.io.BufferedReader.skip. Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned. Parameters n:long Doc from java.io.Reader.skip. The number of characters to skip Returns:long Doc from java.io.Reader.skip. The number of characters actually skipped Annotations @Override Exceptions IOException: Doc from java.io.Reader.skip. If an I/O error occurs

skip

back to summary

public long skip(long n) throws IOException

Overrides java.io.BufferedReader.skip.

Doc from java.io.BufferedReader.skip.

Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned.

Parameters

n:long

Doc from java.io.Reader.skip.

The number of characters to skip

Returns:long

Doc from java.io.Reader.skip.

The number of characters actually skipped

Annotations