Package 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 viaSystem.console().- Since:
- 1.6
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidflush()Flushes the object by writing out any buffered data to the underlying output.Consoleformat(String format, Object... args)Writes a formatted string to the console using the specified format string and arguments.static ConsolegetConsole()Secret accessor forSystem.console.Consoleprintf(String format, Object... args)Equivalent toformat(format, args).Readerreader()Returns theReaderassociated with this console.StringreadLine()Reads a line from the console.StringreadLine(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.PrintWriterwriter()Returns theWriterassociated with this console.
-
-
-
Method Detail
-
getConsole
public static Console getConsole()
Secret accessor forSystem.console.
-
flush
public void flush()
Description copied from interface:FlushableFlushes the object by writing out any buffered data to the underlying output.
-
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 (seeFormatter.format(java.lang.String, java.lang.Object...))args- the list of arguments passed to the formatter. If there are more arguments than required byformat, additional arguments are ignored.- Returns:
- the console instance.
-
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 (seeFormatter.format(java.lang.String, java.lang.Object...))args- the list of arguments passed to the formatter. If there are more arguments than required byformat, 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 theWriterassociated with this console.
-
-