| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public final class Console extends Object implements Flushable
Methods to access the character-based console device, if any, associated with the current Java virtual machine.
Whether a virtual machine has a console is dependent upon the underlying platform and also upon the manner in which the virtual machine is invoked. If the virtual machine is started from an interactive command line without redirecting the standard input and output streams then its console will exist and will typically be connected to the keyboard and display from which the virtual machine was launched. If the virtual machine is started automatically, for example by a background job scheduler, then it will typically not have a console.
If this virtual machine has a console then it is represented by a unique instance of this class which can be obtained by invoking the {@link java.lang.System#console()} method. If no console device is available then an invocation of that method will return null.
Read and write operations are synchronized to guarantee the atomic completion of critical operations; therefore invoking methods {@link #readLine()}, {@link #readPassword()}, {@link #format format()}, {@link #printf printf()} as well as the read, format and write operations on the objects returned by {@link #reader()} and {@link #writer()} may block in multithreaded scenarios.
Invoking close() on the objects returned by the {@link #reader()} and the {@link #writer()} will not close the underlying stream of those objects.
The console-read methods return null when the end of the console input stream is reached, for example by typing control-D on Unix or control-Z on Windows. Subsequent read operations will succeed if additional characters are later entered on the console's input device.
Unless otherwise specified, passing a null argument to any method in this class will cause a {@link NullPointerException} to be thrown.
Security note: If an application needs to read a password or other secure data, it should use {@link #readPassword()} or {@link #readPassword(String, Object...)} and manually zero the returned character array after processing to minimize the lifetime of sensitive data in memory.
Console cons; char[] passwd; if ((cons = System.console()) != null && (passwd = cons.readPassword("[%s]", "Password:")) != null) { ... java.util.Arrays.fill(passwd, ' '); }
Method Summary | |
---|---|
void |
flush() Flushes the console and forces any buffered output to be written immediately . |
Console |
Writes a formatted string to this console's output stream using the specified format string and arguments. |
Console |
A convenience method to write a formatted string to this console's output stream using the specified format string and arguments. |
Reader |
reader() Retrieves the unique java.io.Reader object associated with this console. |
String |
readLine() Reads a single line of text from the console. |
String |
Provides a formatted prompt, then reads a single line of text from the console. |
char[] |
Reads a password or passphrase from the console with echoing disabled |
char[] |
readPassword(String fmt, Object[] args) Provides a formatted prompt, then reads a password or passphrase from the console with echoing disabled. |
PrintWriter |
writer() Retrieves the unique java.io.PrintWriter object associated with this console. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void flush()
public Console format(String fmt, Object[] args)
fmt
- A format string as described in Format string syntaxargs
- Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The number of arguments is
variable and may be zero. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
the Java
Virtual Machine Specification. The behaviour on a
null argument depends on the conversion.public Console printf(String format, Object[] args)
An invocation of this method of the form con.printf(format, args) behaves in exactly the same way as the invocation of
con.format(format, args).
format
- A format string as described in Format string syntax.args
- Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The number of arguments is
variable and may be zero. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
the Java
Virtual Machine Specification. The behaviour on a
null argument depends on the conversion.public Reader reader()
This method is intended to be used by sophisticated applications, for example, a {@link java.util.Scanner} object which utilizes the rich parsing/scanning functionality provided by the Scanner:
Console con = System.console(); if (con != null) { Scanner sc = new Scanner(con.reader()); ... }
For simple applications requiring only line-oriented reading, use {@link #readLine}.
The bulk read operations {@link java.io.Reader#read(char[]) read(char[]) }, {@link java.io.Reader#read(char[], int, int) read(char[], int, int) } and {@link java.io.Reader#read(java.nio.CharBuffer) read(java.nio.CharBuffer)} on the returned object will not read in characters beyond the line bound for each invocation, even if the destination buffer has space for more characters. A line bound is considered to be any one of a line feed ('\n'), a carriage return ('\r'), a carriage return followed immediately by a linefeed, or an end of stream.
public String readLine()
public String readLine(String fmt, Object[] args)
fmt
- A format string as described in Format string syntax.args
- Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
the Java
Virtual Machine Specification.public char[] readPassword()
public char[] readPassword(String fmt, Object[] args)
fmt
- A format string as described in Format string syntax
for the prompt text.args
- Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
the Java
Virtual Machine Specification.public PrintWriter writer()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |