scala.sys.process

ProcessBuilder

Related Docs: object ProcessBuilder | package process

trait ProcessBuilder extends Source with Sink

Represents a sequence of one or more external processes that can be executed. A ProcessBuilder can be a single external process, or a combination of other ProcessBuilder. One can control where a the output of an external process will go to, and where its input will come from, or leave that decision to whoever starts it.

One creates a ProcessBuilder through factories provided in scala.sys.process.Process's companion object, or implicit conversions based on these factories made available in the package object scala.sys.process. Here are some examples:

import scala.sys.process._

// Executes "ls" and sends output to stdout
"ls".!

// Execute "ls" and assign a `Stream[String]` of its output to "contents".
val contents = Process("ls").lineStream

// Here we use a `Seq` to make the parameter whitespace-safe
def contentsOf(dir: String): String = Seq("ls", dir).!!

The methods of ProcessBuilder are divided in three categories: the ones that combine two ProcessBuilder to create a third, the ones that redirect input or output of a ProcessBuilder, and the ones that execute the external processes associated with it.

Combining ProcessBuilder

Two existing ProcessBuilder can be combined in the following ways:

Redirecting Input/Output

Though control of input and output can be done when executing the process, there's a few methods that create a new ProcessBuilder with a pre-configured input or output. They are #<, #> and #>>, and may take as input either another ProcessBuilder (like the pipe described above), or something else such as a java.io.File or a java.io.InputStream. For example:

new URL("http://databinder.net/dispatch/About") #> "grep JSON" #>> new File("About_JSON") !

Starting Processes

To execute all external commands associated with a ProcessBuilder, one may use one of four groups of methods. Each of these methods have various overloads and variations to enable further control over the I/O. These methods are:

Handling Input and Output

If not specified, the input of the external commands executed with run or ! will not be tied to anything, and the output will be redirected to the stdout and stderr of the Scala process. For the methods !! and lines, no input will be provided, and the output will be directed according to the semantics of these methods.

Some methods will cause stdin to be used as input. Output can be controlled with a scala.sys.process.ProcessLogger -- !! and lines will only redirect error output when passed a ProcessLogger. If one desires full control over input and output, then a scala.sys.process.ProcessIO can be used with run.

For example, we could silence the error output from lines_! like this:

val etcFiles = "find /etc" lines_! ProcessLogger(line => ())

Extended Example

Let's examine in detail one example of usage:

import scala.sys.process._
"find src -name *.scala -exec grep null {} ;"  #|  "xargs test -z"  #&&  "echo null-free"  #||  "echo null detected"  !

Note that every String is implicitly converted into a ProcessBuilder through the implicits imported from scala.sys.process. These ProcessBuilder are then combined in three different ways.

  1. #| pipes the output of the first command into the input of the second command. It mirrors a shell pipe (|).
  2. #&& conditionally executes the second command if the previous one finished with exit value 0. It mirrors shell's &&.
  3. #|| conditionally executes the third command if the exit value of the previous command is different than zero. It mirrors shell's ||.

Finally, ! at the end executes the commands, and returns the exit value. Whatever is printed will be sent to the Scala process standard output. If we wanted to capture it, we could run that with !! instead.

Note: though it is not shown above, the equivalent of a shell's ; would be ###. The reason for this name is that ; is a reserved token in Scala.

Note: the lines method, though deprecated, may conflict with the StringLike method of the same name. To avoid this, one may wish to call the builders in Process instead of importing scala.sys.process._. The example above would be

import scala.sys.process.Process
Process("find src -name *.scala -exec grep null {} ;") #| Process("xargs test -z") #&& Process("echo null-free") #|| Process("echo null detected") !
Source
ProcessBuilder.scala
Linear Supertypes
Sink, Source, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ProcessBuilder
  2. Sink
  3. Source
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def !(log: ProcessLogger): Int

    Starts the process represented by this builder, blocks until it exits, and returns the exit code.

    Starts the process represented by this builder, blocks until it exits, and returns the exit code. Standard output and error are sent to the given ProcessLogger.

  2. abstract def !: Int

    Starts the process represented by this builder, blocks until it exits, and returns the exit code.

    Starts the process represented by this builder, blocks until it exits, and returns the exit code. Standard output and error are sent to the console.

  3. abstract def !!(log: ProcessLogger): String

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String.

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String. Standard error is sent to the provided ProcessLogger. If the exit code is non-zero, an exception is thrown.

  4. abstract def !!: String

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String.

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String. Standard error is sent to the console. If the exit code is non-zero, an exception is thrown.

  5. abstract def !!<(log: ProcessLogger): String

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String.

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String. Standard error is sent to the provided ProcessLogger. If the exit code is non-zero, an exception is thrown. The newly started process reads from standard input of the current process.

  6. abstract def !!<: String

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String.

    Starts the process represented by this builder, blocks until it exits, and returns the output as a String. Standard error is sent to the console. If the exit code is non-zero, an exception is thrown. The newly started process reads from standard input of the current process.

  7. abstract def !<(log: ProcessLogger): Int

    Starts the process represented by this builder, blocks until it exits, and returns the exit code.

    Starts the process represented by this builder, blocks until it exits, and returns the exit code. Standard output and error are sent to the given ProcessLogger. The newly started process reads from standard input of the current process.

  8. abstract def !<: Int

    Starts the process represented by this builder, blocks until it exits, and returns the exit code.

    Starts the process represented by this builder, blocks until it exits, and returns the exit code. Standard output and error are sent to the console. The newly started process reads from standard input of the current process.

  9. abstract def ###(other: ProcessBuilder): ProcessBuilder

    Constructs a command that will run this command and then other.

    Constructs a command that will run this command and then other. The exit code will be the exit code of other.

  10. abstract def #&&(other: ProcessBuilder): ProcessBuilder

    Constructs a command that runs this command first and then other if this command succeeds.

  11. abstract def #|(other: ProcessBuilder): ProcessBuilder

    Constructs a command that will run this command and pipes the output to other.

    Constructs a command that will run this command and pipes the output to other. other must be a simple command.

  12. abstract def #||(other: ProcessBuilder): ProcessBuilder

    Constructs a command that runs this command first and then other if this command does not succeed.

  13. abstract def canPipeTo: Boolean

    True if this command can be the target of a pipe.

  14. abstract def hasExitValue: Boolean

    True if this command has an exit code which should be propagated to the user.

    True if this command has an exit code which should be propagated to the user. Given a pipe between A and B, if B.hasExitValue is true then the exit code will be the one from B; if it is false, the one from A. This exists to prevent output redirections (implemented as pipes) from masking useful process error codes.

  15. abstract def lineStream(log: ProcessLogger): Stream[String]

    Starts the process represented by this builder.

    Starts the process represented by this builder. The output is returned as a Stream that blocks when lines are not available but the process has not completed. Standard error is sent to the provided ProcessLogger. If the process exits with a non-zero value, the Stream will provide all lines up to termination and then throw an exception.

  16. abstract def lineStream: Stream[String]

    Starts the process represented by this builder.

    Starts the process represented by this builder. The output is returned as a Stream that blocks when lines are not available but the process has not completed. Standard error is sent to the console. If the process exits with a non-zero value, the Stream will provide all lines up to termination and then throw an exception.

  17. abstract def lineStream_!(log: ProcessLogger): Stream[String]

    Starts the process represented by this builder.

    Starts the process represented by this builder. The output is returned as a Stream that blocks when lines are not available but the process has not completed. Standard error is sent to the provided ProcessLogger. If the process exits with a non-zero value, the Stream will provide all lines up to termination but will not throw an exception.

  18. abstract def lineStream_!: Stream[String]

    Starts the process represented by this builder.

    Starts the process represented by this builder. The output is returned as a Stream that blocks when lines are not available but the process has not completed. Standard error is sent to the console. If the process exits with a non-zero value, the Stream will provide all lines up to termination but will not throw an exception.

  19. abstract def run(log: ProcessLogger, connectInput: Boolean): Process

    Starts the process represented by this builder, blocks until it exits, and returns the exit code.

    Starts the process represented by this builder, blocks until it exits, and returns the exit code. Standard output and error are sent to the given ProcessLogger. The newly started process reads from standard input of the current process if connectInput is true.

  20. abstract def run(connectInput: Boolean): Process

    Starts the process represented by this builder.

    Starts the process represented by this builder. Standard output and error are sent to the console. The newly started process reads from standard input of the current process if connectInput is true.

  21. abstract def run(io: ProcessIO): Process

    Starts the process represented by this builder.

    Starts the process represented by this builder. I/O is handled by the given ProcessIO instance.

  22. abstract def run(log: ProcessLogger): Process

    Starts the process represented by this builder.

    Starts the process represented by this builder. Standard output and error are sent to the given ProcessLogger.

  23. abstract def run(): Process

    Starts the process represented by this builder.

    Starts the process represented by this builder. Standard output and error are sent to the console.

  24. abstract def toSink: ProcessBuilder

    Attributes
    protected
    Definition Classes
    Sink

  25. abstract def toSource: ProcessBuilder

    Attributes
    protected
    Definition Classes
    Source

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any

  3. def #<(b: ProcessBuilder): ProcessBuilder

    Reads the output of a scala.sys.process.ProcessBuilder into the input stream of this process.

    Reads the output of a scala.sys.process.ProcessBuilder into the input stream of this process.

    Definition Classes
    Sink

  4. def #<(in: ⇒ InputStream): ProcessBuilder

    Reads the given InputStream into the input stream of this process.

    Reads the given InputStream into the input stream of this process. The argument is call-by-name, so the stream is recreated, read, and closed each time this process is executed.

    Definition Classes
    Sink

  5. def #<(f: URL): ProcessBuilder

    Reads the given URL into the input stream of this process.

    Reads the given URL into the input stream of this process.

    Definition Classes
    Sink

  6. def #<(f: File): ProcessBuilder

    Reads the given file into the input stream of this process.

    Reads the given file into the input stream of this process.

    Definition Classes
    Sink

  7. def #>(b: ProcessBuilder): ProcessBuilder

    Writes the output stream of this process to a scala.sys.process.ProcessBuilder.

    Writes the output stream of this process to a scala.sys.process.ProcessBuilder.

    Definition Classes
    Source

  8. def #>(out: ⇒ OutputStream): ProcessBuilder

    Writes the output stream of this process to the given OutputStream.

    Writes the output stream of this process to the given OutputStream. The argument is call-by-name, so the stream is recreated, written, and closed each time this process is executed.

    Definition Classes
    Source

  9. def #>(f: File): ProcessBuilder

    Writes the output stream of this process to the given file.

    Writes the output stream of this process to the given file.

    Definition Classes
    Source

  10. def #>>(f: File): ProcessBuilder

    Appends the output stream of this process to the given file.

    Appends the output stream of this process to the given file.

    Definition Classes
    Source

  11. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to any2stringadd[ProcessBuilder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  12. def ->[B](y: B): (ProcessBuilder, B)

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to ArrowAssoc[ProcessBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  13. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any

  14. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  15. def cat: ProcessBuilder

    Returnes a scala.sys.process.ProcessBuilder representing this Source.

    Returnes a scala.sys.process.ProcessBuilder representing this Source.

    Definition Classes
    Source

  16. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  17. def ensuring(cond: (ProcessBuilder) ⇒ Boolean, msg: ⇒ Any): ProcessBuilder

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to Ensuring[ProcessBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: (ProcessBuilder) ⇒ Boolean): ProcessBuilder

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to Ensuring[ProcessBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. def ensuring(cond: Boolean, msg: ⇒ Any): ProcessBuilder

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to Ensuring[ProcessBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. def ensuring(cond: Boolean): ProcessBuilder

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to Ensuring[ProcessBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  21. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any

  23. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  24. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to StringFormat[ProcessBuilder] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  25. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  26. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any

  27. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any

  28. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  30. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  32. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any

  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. def →[B](y: B): (ProcessBuilder, B)

    Implicit information
    This member is added by an implicit conversion from ProcessBuilder to ArrowAssoc[ProcessBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def lines(log: ProcessLogger): Stream[String]

    Deprecated (renamed).

    Deprecated (renamed). Use lineStream(log: ProcessLogger) instead.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use stream instead.

  2. def lines: Stream[String]

    Deprecated (renamed).

    Deprecated (renamed). Use lineStream instead.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use lineStream instead.

  3. def lines_!(log: ProcessLogger): Stream[String]

    Deprecated (renamed).

    Deprecated (renamed). Use lineStream_!(log: ProcessLogger) instead.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use stream_! instead.

  4. def lines_!: Stream[String]

    Deprecated (renamed).

    Deprecated (renamed). Use lineStream_! instead.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use lineStream_! instead.

Inherited from Sink

Inherited from Source

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ProcessBuilder to any2stringadd[ProcessBuilder]

Inherited by implicit conversion StringFormat from ProcessBuilder to StringFormat[ProcessBuilder]

Inherited by implicit conversion Ensuring from ProcessBuilder to Ensuring[ProcessBuilder]

Inherited by implicit conversion ArrowAssoc from ProcessBuilder to ArrowAssoc[ProcessBuilder]

Ungrouped