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:
- 21
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncharset()
Returns theCharset
object used for theConsole
.void
flush()
Flushes the console and forces any buffered output to be written immediately.reader()
Retrieves the uniqueReader
object associated with this console.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.writer()
Retrieves the uniquePrintWriter
object associated with this console.
-
Method Details
-
writer
PrintWriter writer()Retrieves the uniquePrintWriter
object associated with this console.- Returns:
- The printwriter associated with this console
- See Also:
-
reader
Reader reader()Retrieves the uniqueReader
object associated with this console.- Returns:
- The reader associated with this console
- See Also:
-
readLine
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
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 theCharset
object used for theConsole
.- Returns:
- a
Charset
object used for theConsole
- See Also:
-