Package org.eclipse.rdf4j.console
Class ConsoleIO
java.lang.Object
org.eclipse.rdf4j.console.ConsoleIO
- Author:
- Dale Visser
-
Constructor Summary
ConstructorsConstructorDescriptionConsoleIO(InputStream input, OutputStream out, ConsoleState info) ConstructorConsoleIO(ConsoleState info) Constructor -
Method Summary
Modifier and TypeMethodDescriptionbooleanaskProceed(String msg, boolean defaultValue) Ask if the user wants to continueorg.jline.reader.LineReaderGet the JLine line readerGet JLine terminal output streamprotected StringRead a command from inputRead message from inputReads multiple lines from the input until a line that with a '.' on its own is read.readMultiLineInput(String prompt) Reads multiple lines from the input until a line that with a '.' on its own is read.readPassword(String prompt) Read password from inputvoidBe cautious when executing commands, opposite of forceprotected voidsetEcho(boolean echo) Whether to echo user input to output streamvoidsetForce()Force commands to proceedvoidsetQuiet(boolean quiet) Whether to suppress printing of prompts to outputbooleanCheck if an error was written to the consolevoidWrite a stringvoidwriteError(String errMsg) Write an error messagevoidwriteln()Write a newlinevoidWrite a string, followed by a newlinevoidwriteParseError(String prefix, long lineNo, long colNo, String msg) Write parser errorvoidWrite a "please open first" error message
-
Constructor Details
-
ConsoleIO
Constructor- Parameters:
input-out-info-- Throws:
IOException
-
ConsoleIO
Constructor- Parameters:
info-- Throws:
IOException
-
-
Method Details
-
getLineReader
public org.jline.reader.LineReader getLineReader()Get the JLine line reader- Returns:
- line reader
-
getOutputStream
Get JLine terminal output stream- Returns:
- output stream
-
readCommand
Read a command from input- Returns:
- one line of input, or null on error
-
readMultiLineInput
Reads multiple lines from the input until a line that with a '.' on its own is read.- Returns:
- input string
-
readMultiLineInput
Reads multiple lines from the input until a line that with a '.' on its own is read.- Parameters:
prompt-- Returns:
- input string
-
readln
Read message from input- Parameters:
message- one or multiple messages- Returns:
- input string
-
readPassword
Read password from input- Parameters:
prompt- prompt to display- Returns:
- password string
-
write
Write a string- Parameters:
string- string to write
-
writeln
public void writeln()Write a newline -
writeln
Write a string, followed by a newline- Parameters:
string- string to write
-
writeError
Write an error message- Parameters:
errMsg- error message
-
writeUnopenedError
public void writeUnopenedError()Write a "please open first" error message -
writeParseError
Write parser error- Parameters:
prefix-lineNo- line numbercolNo- column numbermsg- message to write
-
askProceed
Ask if the user wants to continue- Parameters:
msg- confirmation questiondefaultValue- true when default is yes- Returns:
- true when continue
-
setEcho
protected void setEcho(boolean echo) Whether to echo user input to output stream- Parameters:
echo- true to echo input
-
setQuiet
public void setQuiet(boolean quiet) Whether to suppress printing of prompts to output- Parameters:
quiet- true to suppress printing
-
setForce
public void setForce()Force commands to proceed -
setCautious
public void setCautious()Be cautious when executing commands, opposite of force -
wasErrorWritten
public boolean wasErrorWritten()Check if an error was written to the console- Returns:
- true when error was written
-