Package com.aspectran.shell.console

Interface Console

All Known Implementing Classes:

AbstractConsole, ConsoleWrapper, DefaultConsole

public interface Console

The Interface for Console I/O.

Created: 2017. 3. 5.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMMENT_DELIMITER
static java.lang.String	COMMENT_PROMPT
static java.lang.String	DEFAULT_PROMPT
static char	MASK_CHAR
static java.lang.String	MULTILINE_DELIMITER
static java.lang.String	MULTILINE_PROMPT

Method Summary

Modifier and Type	Method	Description
void	appendPrompt(java.lang.String string)
void	clearCommandHistory()
void	clearLine()
void	clearPrompt()
void	clearScreen()
boolean	confirmQuit()
boolean	confirmRestart()
boolean	confirmRestart(java.lang.String message)
java.util.List<java.lang.String>	getCommandHistory()
java.lang.String	getCommandPrompt()
java.lang.String	getEncoding()
CommandInterpreter	getInterpreter()
java.io.OutputStream	getOutput()
java.lang.String[]	getStyles()
java.io.File	getWorkingDir()
java.io.PrintWriter	getWriter()
boolean	isBusy()
java.lang.String	readCommandLine()
java.lang.String	readCommandLine(java.lang.String prompt)
java.lang.String	readLine()
java.lang.String	readLine(java.lang.String prompt)
java.lang.String	readLine(java.lang.String prompt, java.lang.String buffer)
java.lang.String	readPassword()
java.lang.String	readPassword(java.lang.String prompt)
java.lang.String	readPassword(java.lang.String prompt, java.lang.String buffer)
void	redrawLine()
void	setCommandHistoryFile(java.lang.String historyFile)
void	setCommandPrompt(java.lang.String commandPrompt)
void	setInterpreter(CommandInterpreter interpreter)
void	setStyle(java.lang.String... styles)
void	setWorkingDir(java.io.File workingDir)
void	styleOff()
void	write(java.lang.String string)
void	write(java.lang.String format, java.lang.Object... args)
void	writeError(java.lang.String string)
void	writeError(java.lang.String format, java.lang.Object... args)
void	writeLine()
void	writeLine(java.lang.String string)
void	writeLine(java.lang.String format, java.lang.Object... args)

Field Detail

DEFAULT_PROMPT

static final java.lang.String DEFAULT_PROMPT

See Also:

Constant Field Values

MULTILINE_PROMPT

static final java.lang.String MULTILINE_PROMPT

See Also:

Constant Field Values

COMMENT_PROMPT

static final java.lang.String COMMENT_PROMPT

See Also:

Constant Field Values

MULTILINE_DELIMITER

static final java.lang.String MULTILINE_DELIMITER

See Also:

Constant Field Values

COMMENT_DELIMITER

static final java.lang.String COMMENT_DELIMITER

See Also:

Constant Field Values

MASK_CHAR

static final char MASK_CHAR

See Also:

Constant Field Values

Method Detail

getEncoding

java.lang.String getEncoding()

getCommandPrompt

java.lang.String getCommandPrompt()

setCommandPrompt

void setCommandPrompt(java.lang.String commandPrompt)

getWorkingDir

java.io.File getWorkingDir()

setWorkingDir

void setWorkingDir(java.io.File workingDir)

getInterpreter

CommandInterpreter getInterpreter()

setInterpreter

void setInterpreter(CommandInterpreter interpreter)

setCommandHistoryFile

void setCommandHistoryFile(java.lang.String historyFile)

getCommandHistory

java.util.List<java.lang.String> getCommandHistory()

clearCommandHistory

void clearCommandHistory()

readCommandLine

java.lang.String readCommandLine()

readCommandLine

java.lang.String readCommandLine(java.lang.String prompt)

readLine

java.lang.String readLine()

readLine

java.lang.String readLine(java.lang.String prompt)

readLine

java.lang.String readLine(java.lang.String prompt,
                          java.lang.String buffer)

readPassword

java.lang.String readPassword()

readPassword

java.lang.String readPassword(java.lang.String prompt)

readPassword

java.lang.String readPassword(java.lang.String prompt,
                              java.lang.String buffer)

write

void write(java.lang.String string)

write

void write(java.lang.String format,
           java.lang.Object... args)

writeLine

void writeLine(java.lang.String string)

writeLine

void writeLine(java.lang.String format,
               java.lang.Object... args)

writeLine

void writeLine()

writeError

void writeError(java.lang.String string)

writeError

void writeError(java.lang.String format,
                java.lang.Object... args)

appendPrompt

void appendPrompt(java.lang.String string)

clearPrompt

void clearPrompt()

clearScreen

void clearScreen()

clearLine

void clearLine()

redrawLine

void redrawLine()

getOutput

java.io.OutputStream getOutput()

getWriter

java.io.PrintWriter getWriter()

getStyles

java.lang.String[] getStyles()

setStyle

void setStyle(java.lang.String... styles)

styleOff

void styleOff()

isBusy

boolean isBusy()

confirmRestart

boolean confirmRestart()

confirmRestart

boolean confirmRestart(java.lang.String message)

confirmQuit

boolean confirmQuit()