Package de.audioattack.io

Interface Console

All Superinterfaces:

Flushable

All Known Implementing Classes:

ConsolePrintDecorator

public interface Console
extends Flushable

Mirrors java.io.Console to allow implementations to work as drop-in replacement for this class.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
Console	format(String fmt, Object... args)	Writes formatted String.
Console	printf(String fmt, Object... args)	Convenience method which writes formatted String.
Reader	reader()	Gets the Reader associated with the console.
String	readLine()	Reads single line.
String	readLine(String fmt, Object... args)	Writes formatted prompt and reads single line.
char[]	readPassword()	Reads password.
char[]	readPassword(String fmt, Object... args)	Writes formatted prompt and reads password.
PrintWriter	writer()	Gets the PrintWriter associated with the console.

Methods inherited from interface java.io.Flushable

flush

Method Detail

reader

Reader reader()

Gets the Reader associated with the console.

Returns:

the reader

See Also:

Console.reader()

writer

PrintWriter writer()

Gets the PrintWriter associated with the console.

Returns:

the writer

See Also:

Console.writer()

format

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

Writes formatted String.

Parameters:

fmt - format String

args - arguments to replace format specifiers in format String

Returns:

this console

See Also:

Console.format(String, Object...)

printf

Console printf(String fmt,
               Object... args)

Convenience method which writes formatted String.

Parameters:

fmt - format String

args - arguments to replace format specifiers in format String

Returns:

this console

See Also:

Console.printf(String, Object...)

readLine

String readLine(String fmt,
                Object... args)

Writes formatted prompt and reads single line.

Parameters:

fmt - format String

args - arguments to replace format specifiers in format String

Returns:

the line

See Also:

Console.readLine(String, Object...)

readLine

String readLine()

Reads single line.

Returns:

the line

See Also:

Console.readLine()

readPassword

char[] readPassword(String fmt,
                    Object... args)

Writes formatted prompt and reads password. Hidden input should be preferred if possible. Implementations which cannot hide input should display a warning that entered text will be visible.

Parameters:

fmt - format String

args - arguments to replace format specifiers in format String

Returns:

the password

See Also:

Console.readPassword(String, Object...)

readPassword

char[] readPassword()

Reads password. Hidden input should be preferred if possible. Implementations which cannot hide input should display a warning that entered text will be visible.

Returns:

the password

See Also:

Console.readPassword()