OpenJDK 27 · java.io.Console · APIdia, the JavaDoc alternative

Methods to access the character-based console device, if any, associated with the current Java virtual machine.

Whether a virtual machine's console exists 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 generally exist and will be connected to the keyboard and display from which the virtual machine was launched. If the standard input or standard output have been redirected (for example, to a file or to a pipe), or if the virtual machine was started from a background job scheduler, the console will not exist.

If the console exists, then it is represented by a unique instance of this class which can be obtained by invoking the System#console() method. If the console does not exist, that method will return null.

Read and write operations are synchronized to guarantee the atomic completion of critical operations; therefore invoking methods readLine(), readPassword(), format(), printf() as well as the read, format and write operations on the objects returned by reader() and writer() may block in multithreaded scenarios.

Read and write operations use the Charsets specified by stdin.encoding and stdout.encoding, respectively. The Charset used for write operations can also be retrieved using the charset() method. Since Console is intended for interactive use on a terminal, these charsets are typically the same.

Operations that format strings are locale sensitive, using either the specified Locale, or the default format Locale to produce localized formatted strings.

Invoking close() on the objects returned by the reader() and the 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 NullPointerException to be thrown.

Security Note

If an application needs to read a password or other secure data, it should use readPassword() or 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, ' ');
}

Field Summary

Modifier and Type	Field and Description
private static final Console	cons
private static final Charset	STDIN_CHARSET
private static final Charset	STDOUT_CHARSET
pack-priv static final int	TTY_STDERR_MASK
pack-priv static final int	TTY_STDIN_MASK
pack-priv static final int	TTY_STDOUT_MASK
private static final int	ttyStatus

Access	Constructor and Description
pack-priv	Console() Package private no-arg constructor.

Method Summary

Modifier and Type	Method and Description
public Charset	Returns: the `Charset` object used for the write operations on this `Console` charset() Returns the `Charset` object used for the write operations on this `Console`.
public void	flush() Implements java.io.Flushable.flush. Flushes the console and forces any buffered output to be written immediately.
public Console	Returns: This console format(String A format string as described in `Format string syntax`. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) Writes a formatted string to this console's output stream using the specified format string and arguments with the `default format locale`.
public Console	Returns: This console format(Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. locale, String A format string as described in `Format string syntax`. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) Writes a formatted string to this console's output stream using the specified format string and arguments with the specified `locale`.
private static Console	instantiateConsole()
private static boolean	isStderrTty()
private static boolean	isStdinTty()
private static boolean	isStdoutTty()
public boolean	Returns: `true` if the `Console` instance is a terminal isTerminal() Returns `true` if the `Console` instance is a terminal.
private static UnsupportedOperationException	newUnsupportedOperationException()
public Console	Returns: This console printf(String A format string as described in `Format string syntax`. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) A convenience method to write a formatted string to this console's output stream using the specified format string and arguments with the `default format locale`.
public Console	Returns: This console printf(Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. locale, String A format string as described in `Format string syntax`. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) A convenience method to write a formatted string to this console's output stream using the specified format string and arguments with the specified `locale`.
public Reader	Returns: The reader associated with this console reader() Retrieves the unique `Reader` object associated with this console.
public String	Returns: A string containing the line read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. readLine(String A format string as described in `Format string syntax`. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) Provides a formatted prompt using the `default format locale`, then reads a single line of text from the console.
public String	Returns: A string containing the line read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. readLine(Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. locale, String A format string as described in `Format string syntax`. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) Provides a formatted prompt using the specified `locale`, then reads a single line of text from the console.
public String	Returns: A string containing the line read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. readLine() Reads a single line of text from the console.
public char[]	Returns: A character array containing the password or passphrase read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. readPassword(String A format string as described in `Format string syntax` for the prompt text. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) Provides a formatted prompt using the `default format locale`, then reads a password or passphrase from the console with echoing disabled.
public char[]	Returns: A character array containing the password or passphrase read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. readPassword(Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. locale, String A format string as described in `Format string syntax` for the prompt text. format, Object... 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 behavior on a `null` argument depends on the `conversion`. args) Provides a formatted prompt using the specified `locale`, then reads a password or passphrase from the console with echoing disabled.
public char[]	Returns: A character array containing the password or passphrase read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. readPassword() Reads a password or passphrase from the console with echoing disabled.
private static native int	ttyStatus()
public PrintWriter	Returns: The printwriter associated with this console writer() Retrieves the unique `PrintWriter` object associated with this console.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cons	back to summary
private static final Console cons

STDIN_CHARSET	back to summary
private static final Charset STDIN_CHARSET

STDOUT_CHARSET	back to summary
private static final Charset STDOUT_CHARSET

TTY_STDERR_MASK	back to summary
pack-priv static final int TTY_STDERR_MASK Annotations @Native

TTY_STDIN_MASK	back to summary
pack-priv static final int TTY_STDIN_MASK Annotations @Native

TTY_STDOUT_MASK	back to summary
pack-priv static final int TTY_STDOUT_MASK Annotations @Native

ttyStatus	back to summary
private static final int ttyStatus

Constructor Detail

Console	back to summary
pack-priv Console() Package private no-arg constructor.

Method Detail

charset back to summary

charset	back to summary
public Charset charset() Returns the `Charset` object used for the write operations on this `Console`. The returned charset is used for encoding the data that is sent to the output (e.g., display), specified by the host environment or user. It defaults to the one based on `stdout.encoding`, and may not necessarily be the same as the default charset returned from `Charset.defaultCharset()`. Returns:Charset the `Charset` object used for the write operations on this `Console` Since 17

public Charset charset()

Returns the Charset object used for the write operations on this Console.

The returned charset is used for encoding the data that is sent to the output (e.g., display), specified by the host environment or user. It defaults to the one based on stdout.encoding, and may not necessarily be the same as the default charset returned from Charset.defaultCharset().

Returns:Charset: the Charset object used for the write operations on this Console
Since: 17

flush	back to summary
public void flush() Implements java.io.Flushable.flush. Flushes the console and forces any buffered output to be written immediately.

flush

back to summary

public void flush()

Implements java.io.Flushable.flush.

Flushes the console and forces any buffered output to be written immediately.

format back to summary

format	back to summary
public Console format(String format, Object... args) Writes a formatted string to this console's output stream using the specified format string and arguments with the `default format locale`. Parameters format:String A format string as described in `Format string syntax`. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:Console This console Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification.

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

Writes a formatted string to this console's output stream using the specified format string and arguments with the default format locale.

Parameters

format:String: A format string as described in Format string syntax.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:Console

This console

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

format back to summary

format	back to summary
public Console format(Locale locale, String format, Object... args) Writes a formatted string to this console's output stream using the specified format string and arguments with the specified `locale`. Parameters locale:Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. format:String A format string as described in `Format string syntax`. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:Console This console Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification. Since 23

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

Writes a formatted string to this console's output stream using the specified format string and arguments with the specified locale.

Parameters

locale:Locale: The locale to apply during formatting. If locale is null then no localization is applied.
format:String: A format string as described in Format string syntax.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:Console

This console

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

Since

instantiateConsole	back to summary
private static Console instantiateConsole()

isStderrTty	back to summary
private static boolean isStderrTty()

isStdinTty	back to summary
private static boolean isStdinTty()

isStdoutTty	back to summary
private static boolean isStdoutTty()

isTerminal back to summary

isTerminal	back to summary
public boolean isTerminal() Returns `true` if the `Console` instance is a terminal. This method always returns `true`, since `System#console()` provides a `Console` instance only when both standard input and output are unredirected, that is, when running in an interactive terminal. Returns:boolean `true` if the `Console` instance is a terminal Since 22

public boolean isTerminal()

Returns true if the Console instance is a terminal.

This method always returns true, since System#console() provides a Console instance only when both standard input and output are unredirected, that is, when running in an interactive terminal.

Returns:boolean: true if the Console instance is a terminal
Since: 22

newUnsupportedOperationException	back to summary
private static UnsupportedOperationException newUnsupportedOperationException()

printf back to summary

printf	back to summary
public Console printf(String format, Object... args) A convenience method to write a formatted string to this console's output stream using the specified format string and arguments with the `default format locale`. Implementation Specification This is the same as calling `format(format, args)`. Parameters format:String A format string as described in `Format string syntax`. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:Console This console Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification.

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

A convenience method to write a formatted string to this console's output stream using the specified format string and arguments with the default format locale.

Implementation Specification

This is the same as calling format(format, args).

Parameters

format:String: A format string as described in Format string syntax.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:Console

This console

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

printf back to summary

printf	back to summary
public Console printf(Locale locale, String format, Object... args) A convenience method to write a formatted string to this console's output stream using the specified format string and arguments with the specified `locale`. Implementation Specification This is the same as calling `format(locale, format, args)`. Parameters locale:Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. format:String A format string as described in `Format string syntax`. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:Console This console Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification. Since 23

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

A convenience method to write a formatted string to this console's output stream using the specified format string and arguments with the specified locale.

Implementation Specification

This is the same as calling format(locale, format, args).

Parameters

locale:Locale: The locale to apply during formatting. If locale is null then no localization is applied.
format:String: A format string as described in Format string syntax.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:Console

This console

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

Since

reader back to summary

reader	back to summary
public Reader reader() Retrieves the unique `Reader` object associated with this console. This method is intended to be used by sophisticated applications, for example, a `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()); code: }` Console con = System.console(); if (con != null) { Scanner sc = new Scanner(con.reader()); ... } For simple applications requiring only line-oriented reading, use `readLine`. The bulk read operations `read(char[])`, `read(char[], int, int)` and `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. The `Reader`'s `read` methods may block if a line bound has not been entered or reached on the console's input device. 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. Returns:Reader The reader associated with this console

public Reader reader()

Retrieves the unique Reader object associated with this console.

This method is intended to be used by sophisticated applications, for example, a 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 readLine.

The bulk read operations read(char[]), read(char[], int, int) and 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. The Reader's read methods may block if a line bound has not been entered or reached on the console's input device. 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.

Returns:Reader: The reader associated with this console

readLine back to summary

readLine	back to summary
public String readLine(String format, Object... args) Provides a formatted prompt using the `default format locale`, then reads a single line of text from the console. Parameters format:String A format string as described in `Format string syntax`. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:String A string containing the line read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification. IOError: If an I/O error occurs.

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

Provides a formatted prompt using the default format locale, then reads a single line of text from the console.

Parameters

format:String: A format string as described in Format string syntax.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:String

A string containing the line read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
IOError:: If an I/O error occurs.

readLine back to summary

readLine	back to summary
public String readLine(Locale locale, String format, Object... args) Provides a formatted prompt using the specified `locale`, then reads a single line of text from the console. Parameters locale:Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. format:String A format string as described in `Format string syntax`. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:String A string containing the line read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification. IOError: If an I/O error occurs. Since 23

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

Provides a formatted prompt using the specified locale, then reads a single line of text from the console.

Parameters

locale:Locale: The locale to apply during formatting. If locale is null then no localization is applied.
format:String: A format string as described in Format string syntax.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:String

A string containing the line read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
IOError:: If an I/O error occurs.

Since

readLine back to summary

readLine	back to summary
public String readLine() Reads a single line of text from the console. Returns:String A string containing the line read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. Exceptions IOError: If an I/O error occurs.

public String readLine()

Reads a single line of text from the console.

Returns:String

A string containing the line read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Exceptions

IOError:: If an I/O error occurs.

readPassword back to summary

readPassword	back to summary
public char[] readPassword(String format, Object... args) Provides a formatted prompt using the `default format locale`, then reads a password or passphrase from the console with echoing disabled. Parameters format:String A format string as described in `Format string syntax` for the prompt text. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:char[] A character array containing the password or passphrase read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification. IOError: If an I/O error occurs.

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

Provides a formatted prompt using the default format locale, then reads a password or passphrase from the console with echoing disabled.

Parameters

format:String: A format string as described in Format string syntax for the prompt text.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:char[]

A character array containing the password or passphrase read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
IOError:: If an I/O error occurs.

readPassword back to summary

readPassword	back to summary
public char[] readPassword(Locale locale, String format, Object... args) Provides a formatted prompt using the specified `locale`, then reads a password or passphrase from the console with echoing disabled. Parameters locale:Locale The locale to apply during formatting. If `locale` is `null` then no localization is applied. format:String A format string as described in `Format string syntax` for the prompt text. args:Object[] 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 behavior on a `null` argument depends on the `conversion`. Returns:char[] A character array containing the password or passphrase read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. Exceptions IllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the `Details` section of the formatter class specification. IOError: If an I/O error occurs. Since 23

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

Provides a formatted prompt using the specified locale, then reads a password or passphrase from the console with echoing disabled.

Parameters

locale:Locale: The locale to apply during formatting. If locale is null then no localization is applied.
format:String: A format string as described in Format string syntax for the prompt text.
args:Object[]: 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 behavior on a null argument depends on the conversion.

Returns:char[]

A character array containing the password or passphrase read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Exceptions

IllegalFormatException:: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
IOError:: If an I/O error occurs.

Since

readPassword back to summary

readPassword	back to summary
public char[] readPassword() Reads a password or passphrase from the console with echoing disabled. Returns:char[] A character array containing the password or passphrase read from the console, not including any line-termination characters, or `null` if an end of stream has been reached. Exceptions IOError: If an I/O error occurs.

public char[] readPassword()

Reads a password or passphrase from the console with echoing disabled.

Returns:char[]

A character array containing the password or passphrase read from the console, not including any line-termination characters, or null if an end of stream has been reached.

Exceptions

IOError:: If an I/O error occurs.

ttyStatus	back to summary
private static native int ttyStatus()

writer back to summary

writer	back to summary
public PrintWriter writer() Retrieves the unique `PrintWriter` object associated with this console. Returns:PrintWriter The printwriter associated with this console

public PrintWriter writer()

Retrieves the unique PrintWriter object associated with this console.

Returns:PrintWriter: The printwriter associated with this console

public sealed Class Console

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail