java.io

Class Console

java.lang.Object

java.io.Console

All Implemented Interfaces:

Flushable

public final class Console
extends Object
implements Flushable

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

Since:

1.6

Method Summary

Modifier and Type	Method and Description
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.
static Console	getConsole() Secret accessor for System.console.
Console	printf(String format, Object... args) Equivalent to format(format, args).
Reader	reader() Returns the Reader associated with this console.
String	readLine() Reads a line from the console.
String	readLine(String format, Object... args) Reads a line from this console, using the specified prompt.
char[]	readPassword() This method is unimplemented on Android.
char[]	readPassword(String format, Object... args) This method is unimplemented on Android.
PrintWriter	writer() Returns the Writer associated with this console.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConsole

public static Console getConsole()

Secret accessor for System.console.

flush

public void flush()

Description copied from interface: Flushable

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

Specified by:

flush in interface Flushable

format

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

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

Parameters:

format - the format string (see Formatter.format(java.lang.String, java.lang.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.

printf

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

Equivalent to format(format, args).

reader

public Reader reader()

Returns the Reader associated with this console.

readLine

public String readLine()

Reads a line from the console.

Returns:

the line, or null at EOF.

readLine

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

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 Formatter.format(java.lang.String, java.lang.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.

readPassword

public char[] readPassword()

This method is unimplemented on Android.

readPassword

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

This method is unimplemented on Android.

writer

public PrintWriter writer()

Returns the Writer associated with this console.