Module io.github.mmm.cli

Package io.github.mmm.cli.io.impl

Class CliConsoleImpl

java.lang.Object

io.github.mmm.cli.io.impl.CliConsoleImpl

All Implemented Interfaces:

CliConsole, Flushable

public class CliConsoleImpl
extends Object
implements CliConsole

Interface for a console as standard in, out, and err. Allows to read user-input and output messages or errors. It is similar to a logger but specific for the needs of command-line-interfaces.

Constructor Summary

Constructors

Constructor	Description
CliConsoleImpl()	The constructor.

Method Summary

Modifier and Type	Method	Description
protected CliOut	createOut(CliLogLevel logLevel)
void	flush()
Locale	getLocale()
CliLogLevel	getLogLevel()
protected PrintStream	getOut(CliLogLevel logLevel)	May be overridden to change defaults (e.g.
protected String	getOutPrefix(CliLogLevel logLevel)	May be overridden to change style (e.g.
PrintStream	getStdErr()
PrintStream	getStdOut()
CliIn	in()
boolean	isPrintStacktrace(CliLogLevel logLevel)
CliOut	out(CliLogLevel logLevel)
void	setIn(CliIn in)
void	setIn(BufferedReader stdIn)
void	setLocale(Locale locale)
void	setLogLevel(CliLogLevel level)
void	setStdErr(PrintStream stdErr)
void	setStdOut(PrintStream stdOut)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mmm.cli.io.CliConsole

debug, error, info, out, warning

Constructor Detail

CliConsoleImpl

public CliConsoleImpl()

The constructor.

Method Detail

getStdOut

public PrintStream getStdOut()

Specified by:

getStdOut in interface CliConsole

Returns:

the PrintStream to use as standard output. Defaults to System.out.

setStdOut

public void setStdOut(PrintStream stdOut)

Parameters:

stdOut - the new value of getStdOut().

getStdErr

public PrintStream getStdErr()

Specified by:

getStdErr in interface CliConsole

Returns:

the PrintStream to use as standard error. Defaults to System.err.

setStdErr

public void setStdErr(PrintStream stdErr)

Parameters:

stdErr - new value of getStdErr().

getLogLevel

public CliLogLevel getLogLevel()

Specified by:

getLogLevel in interface CliConsole

Returns:

the current CliLogLevel of this console.

setLogLevel

public void setLogLevel(CliLogLevel level)

Parameters:

level - new value of getLogLevel().

getLocale

public Locale getLocale()

Returns:

the Locale to use.

setLocale

public void setLocale(Locale locale)

Parameters:

locale - new value of getLocale().

in

public CliIn in()

Specified by:

in in interface CliConsole

Returns:

the CliIn to read input values.

setIn

public void setIn(CliIn in)

Parameters:

in - the new value of in().

setIn

public void setIn(BufferedReader stdIn)

Parameters:

stdIn - the standard input used to read user input from.

out

public CliOut out(CliLogLevel logLevel)

Specified by:

out in interface CliConsole

Parameters:

logLevel - the CliLogLevel.

Returns:

the CliOut for the given CliLogLevel.

createOut

protected CliOut createOut(CliLogLevel logLevel)

Parameters:

logLevel - the CliLogLevel to log to.

Returns:

the CliOut.

getOut

protected PrintStream getOut(CliLogLevel logLevel)

May be overridden to change defaults (e.g. do log warnings on standard out instead of standard error).

Parameters:

logLevel - the CliLogLevel to log to. May be null.

Returns:

the PrintStream to use for the given CliLogLevel.

getOutPrefix

protected String getOutPrefix(CliLogLevel logLevel)

May be overridden to change style (e.g. "[DEBUG] " instead of "DEBUG: ") or to do localization.

Parameters:

logLevel - the CliLogLevel to log to.

Returns:

the prefix to log for the given CliLogLevel.

isPrintStacktrace

public boolean isPrintStacktrace(CliLogLevel logLevel)

Parameters:

logLevel - the CliLogLevel to log to.

Returns:

true if stacktraces should be printed.

flush

public void flush()

Specified by:

flush in interface CliConsole

Specified by:

flush in interface Flushable