Package org.eclipse.rdf4j.console
Class ConsoleIO
- java.lang.Object
-
- org.eclipse.rdf4j.console.ConsoleIO
-
public class ConsoleIO extends Object
- Author:
- Dale Visser
-
-
Constructor Summary
Constructors Constructor Description ConsoleIO(InputStream input, OutputStream out, ConsoleState info)ConstructorConsoleIO(ConsoleState info)Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanaskProceed(String msg, boolean defaultValue)Ask if the user wants to continueorg.jline.reader.LineReadergetLineReader()Get the JLine line readerOutputStreamgetOutputStream()Get JLine terminal output streamprotected StringreadCommand()Read a command from inputStringreadln(String... message)Read message from inputStringreadMultiLineInput()Reads multiple lines from the input until a line that with a '.' on its own is read.StringreadMultiLineInput(String prompt)Reads multiple lines from the input until a line that with a '.' on its own is read.StringreadPassword(String prompt)Read password from inputvoidsetCautious()Be 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 outputbooleanwasErrorWritten()Check if an error was written to the consolevoidwrite(String string)Write a stringvoidwriteError(String errMsg)Write an error messagevoidwriteln()Write a newlinevoidwriteln(String string)Write a string, followed by a newlinevoidwriteParseError(String prefix, long lineNo, long colNo, String msg)Write parser errorvoidwriteUnopenedError()Write a "please open first" error message
-
-
-
Constructor Detail
-
ConsoleIO
public ConsoleIO(InputStream input, OutputStream out, ConsoleState info) throws IOException
Constructor- Parameters:
input-out-info-- Throws:
IOException
-
ConsoleIO
public ConsoleIO(ConsoleState info) throws IOException
Constructor- Parameters:
info-- Throws:
IOException
-
-
Method Detail
-
getLineReader
public org.jline.reader.LineReader getLineReader()
Get the JLine line reader- Returns:
- line reader
-
getOutputStream
public OutputStream getOutputStream()
Get JLine terminal output stream- Returns:
- output stream
-
readCommand
protected String readCommand()
Read a command from input- Returns:
- one line of input, or null on error
-
readMultiLineInput
public String readMultiLineInput()
Reads multiple lines from the input until a line that with a '.' on its own is read.- Returns:
- input string
-
readMultiLineInput
public String readMultiLineInput(String prompt)
Reads multiple lines from the input until a line that with a '.' on its own is read.- Parameters:
prompt-- Returns:
- input string
-
readln
public String readln(String... message)
Read message from input- Parameters:
message- one or multiple messages- Returns:
- input string
-
readPassword
public String readPassword(String prompt)
Read password from input- Parameters:
prompt- prompt to display- Returns:
- password string
-
write
public void write(String string)
Write a string- Parameters:
string- string to write
-
writeln
public void writeln()
Write a newline
-
writeln
public void writeln(String string)
Write a string, followed by a newline- Parameters:
string- string to write
-
writeError
public void writeError(String errMsg)
Write an error message- Parameters:
errMsg- error message
-
writeUnopenedError
public void writeUnopenedError()
Write a "please open first" error message
-
writeParseError
public void writeParseError(String prefix, long lineNo, long colNo, String msg)
Write parser error- Parameters:
prefix-lineNo- line numbercolNo- column numbermsg- message to write
-
askProceed
public boolean askProceed(String msg, boolean defaultValue)
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
-
-