vertx-lang-scala-docs_2.12 3.9.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package shell
  Definition Classes
    ext
-  package command
  Definition Classes
    shell
- Command
- CommandBuilder
- CommandProcess
- CommandRegistry
- CommandResolver

c

io.vertx.scala.ext.shell.command

# CommandProcess 

###
Companion object CommandProcess

#### class CommandProcess extends Tty

The command process provides interaction with the process of the command provided by Vert.x Shell.

Linear Supertypes
Tty, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. CommandProcess
2. Tty
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new CommandProcess(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def args(): Buffer[String]

   returns

     the actual string arguments of the command

5.  def argsTokens(): Buffer[CliToken]

   returns

     the unparsed arguments tokens

6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def asJava: AnyRef
   Definition Classes
     Tty
8.  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

9.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
10.  def commandLine(): CommandLine

    returns

      the command line object or null

11.  def end(status: Int): Unit

    End the process.

    End the process. * @param status the exit status.

12.  def end(): Unit

    End the process with the exit status

13.  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

14.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
16.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
17.  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

18.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
20.  def height(): Int

    returns

      the current height, i.e the number of columns or `-1` if unknown

    Definition Classes
      Tty
21.  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

22.  def isForeground(): Boolean

    returns

      true if the command is running in foreground

23.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
24.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
25.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
27.  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
28.  def resumeHandler(handler: Handler[Unit]): CommandProcess

    Set a resume handler, this handler is called when the command is resumed, for instance user types `bg` or `fg` to resume the command.

    Set a resume handler, this handler is called when the command is resumed, for instance user types `bg` or `fg` to resume the command. * @param handler the interrupt handler

    returns

      this command

29.  def session(): Session

    returns

      the shell session

30.  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
31.  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

32.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
33.  def toString(): String
    Definition Classes
      AnyRef → Any
34.  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
35.  def vertx(): Vertx

    returns

      the current Vert.x instance

36.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
37.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
38.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
39.  def width(): Int

    returns

      the current width, i.e the number of rows or `-1` if unknown

    Definition Classes
      Tty
40.  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

### Inherited from Tty

### Inherited from AnyRef

### Inherited from Any

### Ungrouped