public final class

Console

extends Object
implements Flushable
java.lang.Object
   ↳ java.io.Console

Class Overview

Provides access to the console, if available. The system-wide instance can be accessed via console().

Summary

Public Methods
void flush()
Flushes the object by writing out any buffered data to the underlying output.
Console format(String format, Object... args)
Writes a formatted string to the console using the specified format string and arguments.
Console printf(String format, Object... args)
Equivalent to format(format, args).
String readLine(String format, Object... args)
Reads a line from this console, using the specified prompt.
String readLine()
Reads a line from the console.
char[] readPassword(String format, Object... args)
Reads a password from the console.
char[] readPassword()
Reads a password from the console.
Reader reader()
Returns the Reader associated with this console.
PrintWriter writer()
Returns the Writer associated with this console.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Flushable

Public Methods

public void flush ()

Since: API Level 9

Flushes the object by writing out any buffered data to the underlying output.

public Console format (String format, Object... args)

Since: API Level 9

Writes a formatted string to the console using the specified format string and arguments.

Parameters
format the format string (see format(String, Object...))
args the list of arguments passed to the formatter. If there are more arguments than required by format, additional arguments are ignored.
Returns
  • the console instance.

public Console printf (String format, Object... args)

Since: API Level 9

Equivalent to format(format, args).

public String readLine (String format, Object... args)

Since: API Level 9

Reads a line from this console, using the specified prompt. The prompt is given as a format string and optional arguments. Note that this can be a source of errors: if it is possible that your prompt contains % characters, you must use the format string "%s" and pass the actual prompt as a parameter.

Parameters
format the format string (see format(String, Object...))
args the list of arguments passed to the formatter. If there are more arguments than required by format, additional arguments are ignored.
Returns
  • the line, or null at EOF.

public String readLine ()

Since: API Level 9

Reads a line from the console.

Returns
  • the line, or null at EOF.

public char[] readPassword (String format, Object... args)

Since: API Level 9

Reads a password from the console. The password will not be echoed to the display. A formatted prompt is also displayed.

Parameters
format the format string (see format(String, Object...))
args the list of arguments passed to the formatter. If there are more arguments than required by format, additional arguments are ignored.
Returns
  • a character array containing the password, or null at EOF.

public char[] readPassword ()

Since: API Level 9

Reads a password from the console. The password will not be echoed to the display.

Returns
  • a character array containing the password, or null at EOF.

public Reader reader ()

Since: API Level 9

Returns the Reader associated with this console.

public PrintWriter writer ()

Since: API Level 9

Returns the Writer associated with this console.