Class Term
- java.lang.Object
-
- io.vertx.reactivex.ext.shell.term.Tty
-
- io.vertx.reactivex.ext.shell.term.Term
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<Term>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Close the connection to terminal.Term
closeHandler(Handler<Void> handler)
Set a handler that will be called when the terminal is closed.Term
echo(String text)
Echo some text in the terminal, escaped if necessary.boolean
equals(Object o)
Term
getDelegate()
int
hashCode()
Term
interruptHandler(SignalHandler handler)
Set an interrupt signal handler on the term.long
lastAccessedTime()
static Term
newInstance(Term arg)
void
readline(String prompt, Handler<String> lineHandler)
Prompt the user a line of text.void
readline(String prompt, Handler<String> lineHandler, Handler<Completion> completionHandler)
Prompt the user a line of text, providing a completion handler to handle user's completion.Term
resizehandler(Handler<Void> handler)
Set a resize handler, the handler is called when the tty size changes.Term
setSession(Session session)
Associate the term with a session.Term
stdinHandler(Handler<String> handler)
Set a stream handler on the standard input to read the data.Term
suspendHandler(SignalHandler handler)
Set a suspend signal handler on the term.String
toString()
Term
write(String data)
Write data to the standard output.-
Methods inherited from class io.vertx.reactivex.ext.shell.term.Tty
height, newInstance, type, width
-
-
-
-
Method Detail
-
getDelegate
public Term getDelegate()
- Overrides:
getDelegate
in classTty
-
resizehandler
public Term resizehandler(Handler<Void> handler)
Description copied from class:Tty
Set a resize handler, the handler is called when the tty size changes.- Overrides:
resizehandler
in classTty
- Parameters:
handler
- the resize handler- Returns:
- this object
-
stdinHandler
public Term stdinHandler(Handler<String> handler)
Description copied from class:Tty
Set a stream handler on the standard input to read the data.- Overrides:
stdinHandler
in classTty
- Parameters:
handler
- the standard input- Returns:
- this object
-
write
public Term write(String data)
Description copied from class:Tty
Write data to the standard output.
-
lastAccessedTime
public long lastAccessedTime()
- Returns:
- the last time this term received input
-
echo
public Term echo(String text)
Echo some text in the terminal, escaped if necessary.- Parameters:
text
- the text to echo- Returns:
- a reference to this, so the API can be used fluently
-
setSession
public Term setSession(Session session)
Associate the term with a session.- Parameters:
session
- the session to set- Returns:
- a reference to this, so the API can be used fluently
-
interruptHandler
public Term interruptHandler(SignalHandler handler)
Set an interrupt signal handler on the term.- Parameters:
handler
- the interrupt handler- Returns:
- a reference to this, so the API can be used fluently
-
suspendHandler
public Term suspendHandler(SignalHandler handler)
Set a suspend signal handler on the term.- Parameters:
handler
- the suspend handler- Returns:
- a reference to this, so the API can be used fluently
-
readline
public void readline(String prompt, Handler<String> lineHandler)
Prompt the user a line of text.- Parameters:
prompt
- the displayed promptlineHandler
- the line handler called with the line
-
readline
public void readline(String prompt, Handler<String> lineHandler, Handler<Completion> completionHandler)
Prompt the user a line of text, providing a completion handler to handle user's completion.- Parameters:
prompt
- the displayed promptlineHandler
- the line handler called with the linecompletionHandler
- the completion handler
-
closeHandler
public Term closeHandler(Handler<Void> handler)
Set a handler that will be called when the terminal is closed.- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
close
public void close()
Close the connection to terminal.
-
-