afterReadLine
public void afterReadLine(ConsoleReader reader,
String prompt,
Character mask)
Invokes after the console reads a line with the prompt and mask.
beforeReadLine
public void beforeReadLine(ConsoleReader reader,
String prompt,
Character mask)
Invokes before the console reads a line with the prompt and mask.
disableEcho
public abstract void disableEcho()
Disable character echoing. This can be used to manually re-enable
character if the ConsoleReader has been disabled.
enableEcho
public abstract void enableEcho()
Enable character echoing. This can be used to re-enable character
if the ConsoleReader is no longer being used.
getDefaultBindings
public InputStream getDefaultBindings()
getEcho
public abstract boolean getEcho()
Returns true if the terminal will echo all characters type.
getTerminal
public static Terminal getTerminal()
getTerminalHeight
public abstract int getTerminalHeight()
Returns the current height of the terminal (in lines)
getTerminalWidth
public abstract int getTerminalWidth()
Returns the current width of the terminal (in characters)
initializeTerminal
public abstract void initializeTerminal()
throws Exception
Initialize any system settings
that are required for the console to be able to handle
input correctly, such as setting tabtop, buffered input, and
character echo.
isANSISupported
public boolean isANSISupported()
Returns true if the current console supports ANSI
codes.
isEchoEnabled
public abstract boolean isEchoEnabled()
Returns false if character echoing is disabled.
isSupported
public abstract boolean isSupported()
Returns true if this terminal is capable of initializing the
terminal to use jline.
readCharacter
public int readCharacter(InputStream in)
throws IOException
Read a single character from the input stream. This might
enable a terminal implementation to better handle nuances of
the console.
readVirtualKey
public int readVirtualKey(InputStream in)
throws IOException
Reads a virtual key from the console. Typically, this will
just be the raw character that was entered, but in some cases,
multiple input keys will need to be translated into a single
virtual key.
in
- the InputStream to read from
- the virtual key (e.g.,
ConsoleOperations
)
resetTerminal
public static void resetTerminal()
Reset the current terminal to null.
setupTerminal
public static Terminal setupTerminal()
Configure and return the
Terminal
instance for the
current platform. This will initialize any system settings
that are required for the console to be able to handle
input correctly, such as setting tabtop, buffered input, and
character echo.
This class will use the Terminal implementation specified in the
jline.terminal system property, or, if it is unset, by
detecting the operating system from the
os.name
system property and instantiating either the
WindowsTerminalTest
or
UnixTerminal
.