Class CommandProcess
- java.lang.Object
-
- io.vertx.reactivex.ext.shell.term.Tty
-
- io.vertx.reactivex.ext.shell.command.CommandProcess
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<CommandProcess>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description CommandProcess(CommandProcess delegate)
CommandProcess(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
args()
List<CliToken>
argsTokens()
CommandProcess
backgroundHandler(Handler<Void> handler)
Set a background handler, this handler is called when the command is running and put to background.CommandLine
commandLine()
void
end()
End the process with the exit statusvoid
end(int status)
End the process.CommandProcess
endHandler(Handler<Void> handler)
Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes.boolean
equals(Object o)
CommandProcess
foregroundHandler(Handler<Void> handler)
Set a foreground handler, this handler is called when the command is running and put to foreground.CommandProcess
getDelegate()
int
hashCode()
CommandProcess
interruptHandler(Handler<Void> handler)
Set an interrupt handler, this handler is called when the command is interrupted, for instance user pressCtrl-C
.boolean
isForeground()
static CommandProcess
newInstance(CommandProcess arg)
CommandProcess
resizehandler(Handler<Void> handler)
Set a resize handler, the handler is called when the tty size changes.CommandProcess
resumeHandler(Handler<Void> handler)
Set a resume handler, this handler is called when the command is resumed, for instance user typesbg
orfg
to resume the command.Session
session()
CommandProcess
stdinHandler(Handler<String> handler)
Set a stream handler on the standard input to read the data.CommandProcess
suspendHandler(Handler<Void> handler)
Set a suspend handler, this handler is called when the command is suspended, for instance user pressCtrl-Z
.String
toString()
Vertx
vertx()
CommandProcess
write(String data)
Write some text to the standard output.-
Methods inherited from class io.vertx.reactivex.ext.shell.term.Tty
height, newInstance, type, width
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<CommandProcess> __TYPE_ARG
-
-
Constructor Detail
-
CommandProcess
public CommandProcess(CommandProcess delegate)
-
CommandProcess
public CommandProcess(Object delegate)
-
-
Method Detail
-
getDelegate
public CommandProcess getDelegate()
- Overrides:
getDelegate
in classTty
-
vertx
public Vertx vertx()
- Returns:
- the current Vert.x instance
-
commandLine
public CommandLine commandLine()
- Returns:
- the command line object or null
-
session
public Session session()
- Returns:
- the shell session
-
isForeground
public boolean isForeground()
- Returns:
- true if the command is running in foreground
-
stdinHandler
public CommandProcess 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
-
interruptHandler
public CommandProcess interruptHandler(Handler<Void> handler)
Set an interrupt handler, this handler is called when the command is interrupted, for instance user pressCtrl-C
.- Parameters:
handler
- the interrupt handler- Returns:
- this command
-
suspendHandler
public CommandProcess suspendHandler(Handler<Void> handler)
Set a suspend handler, this handler is called when the command is suspended, for instance user pressCtrl-Z
.- Parameters:
handler
- the interrupt handler- Returns:
- this command
-
resumeHandler
public CommandProcess resumeHandler(Handler<Void> handler)
Set a resume handler, this handler is called when the command is resumed, for instance user typesbg
orfg
to resume the command.- Parameters:
handler
- the interrupt handler- Returns:
- this command
-
endHandler
public CommandProcess endHandler(Handler<Void> handler)
Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes.- Parameters:
handler
- the end handler- Returns:
- a reference to this, so the API can be used fluently
-
write
public CommandProcess write(String data)
Write some text to the standard output.
-
backgroundHandler
public CommandProcess backgroundHandler(Handler<Void> handler)
Set a background handler, this handler is called when the command is running and put to background.- Parameters:
handler
- the background handler- Returns:
- this command
-
foregroundHandler
public CommandProcess foregroundHandler(Handler<Void> handler)
Set a foreground handler, this handler is called when the command is running and put to foreground.- Parameters:
handler
- the foreground handler- Returns:
- this command
-
resizehandler
public CommandProcess 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
-
end
public void end()
End the process with the exit status
-
end
public void end(int status)
End the process.- Parameters:
status
- the exit status.
-
newInstance
public static CommandProcess newInstance(CommandProcess arg)
-
-