Package com.aspectran.shell.console
Interface ShellConsole
-
- All Known Implementing Classes:
AbstractShellConsole
,DefaultShellConsole
,JLineShellConsole
,ShellConsoleWrapper
public interface ShellConsole
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearCommandHistory()
void
clearLine()
void
clearScreen()
boolean
confirmQuit()
boolean
confirmRestart()
void
dangerStyle()
java.util.List<java.lang.String>
getCommandHistory()
java.lang.String
getCommandPrompt()
ConsoleCommander
getConsoleCommander()
java.lang.String[]
getDangerStyle()
java.lang.String
getEncoding()
java.lang.String[]
getInfoStyle()
java.io.PrintStream
getOutput()
java.lang.String[]
getPrimaryStyle()
java.lang.String[]
getSecondaryStyle()
java.lang.String[]
getSuccessStyle()
java.lang.String[]
getWarningStyle()
java.io.File
getWorkingDir()
java.io.PrintWriter
getWriter()
boolean
hasStyle()
void
infoStyle()
boolean
isReading()
PromptStringBuilder
newPromptStringBuilder()
java.lang.String
readCommandLine()
java.lang.String
readLine()
java.lang.String
readLine(PromptStringBuilder promptStringBuilder)
java.lang.String
readPassword()
java.lang.String
readPassword(PromptStringBuilder promptStringBuilder)
void
redrawLine()
void
resetStyle()
void
resetStyle(java.lang.String... styles)
void
secondaryStyle()
void
setCommandHistoryFile(java.lang.String historyFile)
void
setCommandPrompt(java.lang.String commandPrompt)
void
setConsoleCommander(ConsoleCommander runner)
void
setShellStyleConfig(ShellStyleConfig shellStyleConfig)
void
setStyle(java.lang.String... styles)
void
setWorkingDir(java.io.File workingDir)
void
successStyle()
void
warningStyle()
void
write(java.lang.String str)
void
write(java.lang.String format, java.lang.Object... args)
void
writeAbove(java.lang.String str)
void
writeError(java.lang.String str)
void
writeError(java.lang.String format, java.lang.Object... args)
void
writeLine()
void
writeLine(java.lang.String str)
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()
-
getOutput
java.io.PrintStream getOutput()
-
getWriter
java.io.PrintWriter getWriter()
-
getWorkingDir
java.io.File getWorkingDir()
-
setWorkingDir
void setWorkingDir(java.io.File workingDir)
-
getConsoleCommander
ConsoleCommander getConsoleCommander()
-
setConsoleCommander
void setConsoleCommander(ConsoleCommander runner)
-
setCommandHistoryFile
void setCommandHistoryFile(java.lang.String historyFile)
-
getCommandHistory
java.util.List<java.lang.String> getCommandHistory()
-
clearCommandHistory
void clearCommandHistory()
-
getCommandPrompt
java.lang.String getCommandPrompt()
-
setCommandPrompt
void setCommandPrompt(java.lang.String commandPrompt)
-
newPromptStringBuilder
PromptStringBuilder newPromptStringBuilder()
-
readCommandLine
java.lang.String readCommandLine()
-
readLine
java.lang.String readLine()
-
readLine
java.lang.String readLine(PromptStringBuilder promptStringBuilder)
-
readPassword
java.lang.String readPassword()
-
readPassword
java.lang.String readPassword(PromptStringBuilder promptStringBuilder)
-
write
void write(java.lang.String str)
-
write
void write(java.lang.String format, java.lang.Object... args)
-
writeLine
void writeLine(java.lang.String str)
-
writeLine
void writeLine(java.lang.String format, java.lang.Object... args)
-
writeLine
void writeLine()
-
writeError
void writeError(java.lang.String str)
-
writeError
void writeError(java.lang.String format, java.lang.Object... args)
-
writeAbove
void writeAbove(java.lang.String str)
-
clearScreen
void clearScreen()
-
clearLine
void clearLine()
-
redrawLine
void redrawLine()
-
isReading
boolean isReading()
-
hasStyle
boolean hasStyle()
-
setStyle
void setStyle(java.lang.String... styles)
-
resetStyle
void resetStyle()
-
resetStyle
void resetStyle(java.lang.String... styles)
-
setShellStyleConfig
void setShellStyleConfig(ShellStyleConfig shellStyleConfig)
-
getPrimaryStyle
java.lang.String[] getPrimaryStyle()
-
getSecondaryStyle
java.lang.String[] getSecondaryStyle()
-
getSuccessStyle
java.lang.String[] getSuccessStyle()
-
getDangerStyle
java.lang.String[] getDangerStyle()
-
getWarningStyle
java.lang.String[] getWarningStyle()
-
getInfoStyle
java.lang.String[] getInfoStyle()
-
secondaryStyle
void secondaryStyle()
-
successStyle
void successStyle()
-
dangerStyle
void dangerStyle()
-
warningStyle
void warningStyle()
-
infoStyle
void infoStyle()
-
confirmRestart
boolean confirmRestart()
-
confirmQuit
boolean confirmQuit()
-
-