OpenJDK 27 · jdk.internal.org.jline.utils.NonBlockingReader

Modifier and Type	Field and Description
public static final int	EOF
public static final int	READ_EXPIRED

Access	Constructor and Description
public	NonBlockingReader()

Method Summary

Modifier and Type	Method and Description
public int	available()
public int	Returns: -1 on eof, -2 if the timeout expired with no available input or the character that was read (without consuming it). peek(long The amount of time to wait, 0 == forever timeout) Peeks to see if there is a byte waiting in the input stream without actually consuming the byte.
public int	read() Overrides java.io.Reader.read. Reads a single character.
public int	Returns: The character read, -1 if EOF is reached, or -2 if the read timed out. read(long The amount of time to wait for the character timeout) Attempts to read a character from the input stream for a specific period of time.
public int	read(char[] the buffer b, int the offset in the buffer off, int the maximum number of chars to read len) Implements abstract java.io.Reader.read. This version of read() is very specific to jline's purposes, it will always always return a single byte at a time, rather than filling the entire buffer.
protected abstract int	Returns: The character read, -1 if EOF is reached, or -2 if the read timed out. read(long The amount of time to wait for the character timeout, boolean `true`if the character read must not be consumed isPeek) Attempts to read a character from the input stream for a specific period of time.
public int	readBuffered(char[] b)
public int	readBuffered(char[] b, long timeout)
public abstract int	readBuffered(char[] b, int off, int len, long timeout)
public void	shutdown() Shuts down the thread that is handling blocking I/O.

Inherited from java.io.Reader:: close mark markSupported nullReader of read read readAllAsString readAllLines ready reset skip transferTo

EOF	back to summary
public static final int EOF

READ_EXPIRED	back to summary
public static final int READ_EXPIRED

NonBlockingReader	back to summary
public NonBlockingReader()

Method Detail

available	back to summary
public int available()

peek	back to summary
public int peek(long timeout) throws IOException Peeks to see if there is a byte waiting in the input stream without actually consuming the byte. Parameters timeout:long The amount of time to wait, 0 == forever Returns:int -1 on eof, -2 if the timeout expired with no available input or the character that was read (without consuming it). Exceptions IOException: if anything wrong happens

peek

back to summary

public int peek(long timeout) throws IOException

Peeks to see if there is a byte waiting in the input stream without actually consuming the byte.

Parameters

timeout:long: The amount of time to wait, 0 == forever

Returns:int

-1 on eof, -2 if the timeout expired with no available input or the character that was read (without consuming it).

Exceptions

IOException:: if anything wrong happens

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. Doc from java.io.Reader.read. Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached. Subclasses that intend to support efficient single-character input should override this method. Annotations @Override Exceptions IOException: If an I/O error occurs

read

back to summary

public int read() throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached.

Subclasses that intend to support efficient single-character input should override this method.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read	back to summary
public int read(long timeout) throws IOException Attempts to read a character from the input stream for a specific period of time. Parameters timeout:long The amount of time to wait for the character Returns:int The character read, -1 if EOF is reached, or -2 if the read timed out. Exceptions IOException: if anything wrong happens

read

back to summary

public int read(long timeout) throws IOException

Attempts to read a character from the input stream for a specific period of time.

Parameters

timeout:long: The amount of time to wait for the character

Returns:int

The character read, -1 if EOF is reached, or -2 if the read timed out.

Exceptions

IOException:: if anything wrong happens

read	back to summary
public int read(char[] b, int off, int len) throws IOException Implements abstract java.io.Reader.read. This version of read() is very specific to jline's purposes, it will always always return a single byte at a time, rather than filling the entire buffer. Parameters b:char[] the buffer off:int the offset in the buffer len:int the maximum number of chars to read Annotations @Override Exceptions IOException: if anything wrong happens

read

back to summary

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

Implements abstract java.io.Reader.read.

This version of read() is very specific to jline's purposes, it will always always return a single byte at a time, rather than filling the entire buffer.

Parameters

b:char[]: the buffer
off:int: the offset in the buffer
len:int: the maximum number of chars to read

Annotations

@Override

Exceptions

IOException:: if anything wrong happens

read back to summary

read	back to summary
protected abstract int read(long timeout, boolean isPeek) throws IOException Attempts to read a character from the input stream for a specific period of time. Parameters timeout:long The amount of time to wait for the character isPeek:boolean `true`if the character read must not be consumed Returns:int The character read, -1 if EOF is reached, or -2 if the read timed out. Exceptions IOException: if anything wrong happens

protected abstract int read(long timeout, boolean isPeek) throws IOException

Attempts to read a character from the input stream for a specific period of time.

Parameters

timeout:long: The amount of time to wait for the character
isPeek:boolean: trueif the character read must not be consumed

Returns:int

The character read, -1 if EOF is reached, or -2 if the read timed out.

Exceptions

IOException:: if anything wrong happens

readBuffered	back to summary
public int readBuffered(char[] b) throws IOException

readBuffered	back to summary
public int readBuffered(char[] b, long timeout) throws IOException

readBuffered	back to summary
public abstract int readBuffered(char[] b, int off, int len, long timeout) throws IOException

shutdown	back to summary
public void shutdown() Shuts down the thread that is handling blocking I/O. Note that if the thread is currently blocked waiting for I/O it will not actually shut down until the I/O is received.

public abstract Class NonBlockingReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail