Console

AI-generated Key Takeaways

• The Console class provides access to the system console for reading input and writing output.

• It offers methods for reading lines, passwords (unimplemented on Android), and formatting output.

• Console includes functionalities for flushing buffered output and accessing associated Reader and Writer objects.

• A system-wide Console instance can be obtained using System.console().

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().

Public Method Summary

void	flush() Flushes this stream by writing any buffered output to the underlying stream.
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() 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.
Reader	reader() Returns the Reader associated with this console.
PrintWriter	writer() Returns the Writer associated with this console.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

Public Methods

public void flush ()

Flushes this stream by writing any buffered output to the underlying stream.

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(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)

Equivalent to format(format, args).

Parameters

format
args

public String readLine ()

Reads a line from the console.

Returns

• the line, or null at EOF.

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(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 char[] readPassword ()

This method is unimplemented on Android.

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

This method is unimplemented on Android.

Parameters

format
args

public Reader reader ()

Returns the Reader associated with this console.

public PrintWriter writer ()

Returns the Writer associated with this console.