class CommandProcess extends Tty
The command process provides interaction with the process of the command provided by Vert.x Shell.
- Alphabetic
- By Inheritance
- CommandProcess
- Tty
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-  new CommandProcess(_asJava: AnyRef)
Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        args(): Buffer[String]
      
      
      - returns
- the actual string arguments of the command 
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        argsTokens(): Buffer[CliToken]
      
      
      - returns
- the unparsed arguments tokens 
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      - Definition Classes
- Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        asJava: AnyRef
      
      
      - Definition Classes
- Tty
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        backgroundHandler(handler: Handler[Unit]): CommandProcess
      
      
      Set a background handler, this handler is called when the command is running and put to background. Set a background handler, this handler is called when the command is running and put to background. * @param handler the background handler - returns
- this command 
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      - Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        commandLine(): CommandLine
      
      
      - returns
- the command line object or null 
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        end(status: Int): Unit
      
      
      End the process. End the process. * @param status the exit status. 
- 
      
      
      
        
      
    
      
        
        def
      
      
        end(): Unit
      
      
      End the process with the exit status 
- 
      
      
      
        
      
    
      
        
        def
      
      
        endHandler(handler: Handler[Unit]): CommandProcess
      
      
      Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes. Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes. * @param handler the end handler - returns
- a reference to this, so the API can be used fluently 
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      - Definition Classes
- AnyRef
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      - Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        foregroundHandler(handler: Handler[Unit]): CommandProcess
      
      
      Set a foreground handler, this handler is called when the command is running and put to foreground. Set a foreground handler, this handler is called when the command is running and put to foreground. * @param handler the foreground handler - returns
- this command 
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      - Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      - Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        height(): Int
      
      
      - returns
- the current height, i.e the number of columns or - -1if unknown
 - Definition Classes
- Tty
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        interruptHandler(handler: Handler[Unit]): CommandProcess
      
      
      Set an interrupt handler, this handler is called when the command is interrupted, for instance user press Ctrl-C.Set an interrupt handler, this handler is called when the command is interrupted, for instance user press Ctrl-C. * @param handler the interrupt handler- returns
- this command 
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        isForeground(): Boolean
      
      
      - returns
- true if the command is running in foreground 
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      - Definition Classes
- Any
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      - Definition Classes
- AnyRef
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        resizehandler(handler: Handler[Unit]): CommandProcess
      
      
      Set a resize handler, the handler is called when the tty size changes. Set a resize handler, the handler is called when the tty size changes. * @param handler the resize handler - returns
- this object 
 - Definition Classes
- CommandProcess → Tty
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        resumeHandler(handler: Handler[Unit]): CommandProcess
      
      
      Set a resume handler, this handler is called when the command is resumed, for instance user types bgorfgto resume the command.Set a resume handler, this handler is called when the command is resumed, for instance user types bgorfgto resume the command. * @param handler the interrupt handler- returns
- this command 
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        session(): Session
      
      
      - returns
- the shell session 
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        stdinHandler(handler: Handler[String]): CommandProcess
      
      
      Set a stream handler on the standard input to read the data. Set a stream handler on the standard input to read the data. * @param handler the standard input - returns
- this object 
 - Definition Classes
- CommandProcess → Tty
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        suspendHandler(handler: Handler[Unit]): CommandProcess
      
      
      Set a suspend handler, this handler is called when the command is suspended, for instance user press Ctrl-Z.Set a suspend handler, this handler is called when the command is suspended, for instance user press Ctrl-Z. * @param handler the interrupt handler- returns
- this command 
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      - Definition Classes
- AnyRef
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        type(): String
      
      
      - returns
- the declared tty type, for instance - vt100,- xterm-256, etc... it can be null when the tty does not have declared its type.
 - Definition Classes
- Tty
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        vertx(): Vertx
      
      
      - returns
- the current Vert.x instance 
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @throws( ... )
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @throws( ... )
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        width(): Int
      
      
      - returns
- the current width, i.e the number of rows or - -1if unknown
 - Definition Classes
- Tty
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        write(data: String): CommandProcess
      
      
      Write some text to the standard output. Write some text to the standard output. * @param data the text - returns
- a reference to this, so the API can be used fluently 
 - Definition Classes
- CommandProcess → Tty