Interface JShellConsole

public interface JShellConsole

An interface providing functionality for Console in the user's snippet.

When a snippet calls a method on Console, the corresponding method in this interface will be called.

Since:

See Also:

Method Summary

Modifier and Type	Method	Description
`Charset`	`charset()`	Returns the `Charset` object used for the `Console`.
`void`	`flush()`	Flushes the console and forces any buffered output to be written immediately.
`Reader`	`reader()`	Retrieves the unique `Reader` object associated with this console.
`String`	`readLine(String prompt)`	Provides a prompt, then reads a single line of text from the console.
`char[]`	`readPassword(String prompt)`	Provides a prompt, then reads a password or passphrase from the console with echoing disabled.
`PrintWriter`	`writer()`	Retrieves the unique `PrintWriter` object associated with this console.

Method Details

writer

PrintWriter writer()

Retrieves the unique PrintWriter object associated with this console.

Returns:

The printwriter associated with this console

See Also:

reader

Reader reader()

Retrieves the unique Reader object associated with this console.

Returns:

The reader associated with this console

See Also:

readLine

String readLine(String prompt) throws IOError

Provides a prompt, then reads a single line of text from the console.

Parameters:

prompt - A prompt.

Returns:

A string containing the line read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IOError - If an I/O error occurs.

See Also:

readPassword

char[] readPassword(String prompt) throws IOError

Provides a prompt, then reads a password or passphrase from the console with echoing disabled.

Parameters:

prompt - A prompt.

Returns:

A character array containing the password or passphrase read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IOError - If an I/O error occurs.

See Also:

flush

void flush()

Flushes the console and forces any buffered output to be written immediately.

See Also:

charset

Charset charset()

Returns the Charset object used for the Console.

Returns:

a Charset object used for the Console

See Also:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.jshell/jdk/jshell/JShellConsole.html