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.
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.
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.
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.
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.
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.
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.
Constructs a command that runs this command first and then other if this command succeeds.
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.
Constructs a command that runs this command first and then other if this command does not succeed.
True if this command can be the target of a pipe.
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.
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.
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.
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.
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.
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.
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.
Starts the process represented by this builder.
Starts the process represented by this builder. I/O is handled by the given ProcessIO instance.
Starts the process represented by this builder.
Starts the process represented by this builder. Standard output and error are sent to the given ProcessLogger.
Starts the process represented by this builder.
Starts the process represented by this builder. Standard output and error are sent to the console.
Test two objects for inequality.
Test two objects for inequality.
true if !(this == that), false otherwise.
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.
a hash value consistent with ==
Reads the output of a ProcessBuilder into the input stream of this process.
Reads the output of a ProcessBuilder into the input stream of this process.
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.
Reads the given URL into the input stream of this process.
Reads the given URL into the input stream of this process.
Reads the given file into the input stream of this process.
Reads the given file into the input stream of this process.
Writes the output stream of this process to a ProcessBuilder.
Writes the output stream of this process to a 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.
Writes the output stream of this process to the given file.
Writes the output stream of this process to the given file.
Appends the output stream of this process to the given file.
Appends the output stream of this process to the given file.
Test two objects for equality.
Test two objects for equality.
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
true if the receiver object is equivalent to the argument; false otherwise.
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.
the receiver object.
if the receiver object is not an instance of the erasure of type T0.
Returnes a ProcessBuilder representing this Source.
Returnes a ProcessBuilder representing this Source.
Create a copy of the receiver object.
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:
x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.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).
true if the argument is a reference to the receiver object; false otherwise.
The equality method for reference types.
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.
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.
a representation that corresponds to the dynamic class of the receiver object.
not specified by SLS as a member of AnyRef
The hashCode method for reference types.
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.
true if the receiver object is an instance of erasure of type T0; false otherwise.
Equivalent to !(this eq that).
Equivalent to !(this eq that).
true if the argument is not a reference to the receiver object; false otherwise.
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.
not specified by SLS as a member of AnyRef
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.
not specified by SLS as a member of AnyRef
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.
a String representation of the object.
Represents a runnable process.
This is the main component of this package. A
ProcessBuildermay be composed with others, either concatenating their outputs or piping them from one to the next, and possibly with conditional execution depending on the last process exit value.Once executed, one can retrieve the output or redirect it to a ProcessLogger, or one can get the exit value, discarding or redirecting the output.
One creates a
ProcessBuilderthrough factories provided in Process's companion object, or implicit conversions based on these factories made available in the package object process.Let's examine in detail one example of usage:
Note that every
Stringis implicitly converted into aProcessBuilderthrough the implicits imported from process. TheseProcessBuilderare then combined in three different ways.#|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&&.Not shown here, the equivalent of a shell's
;would be###. The reason for this name is that;is a reserved token in Scala.Finally,
!at the end executes the commands, and returns the exit value. If the output was desired instead, one could run that with!!instead.If one wishes to execute the commands in background, one can either call
run, which returns a Process from which the exit value can be obtained, orlines, which returns a [scala.collection.immutable.Stream] of output lines. This throws an exception at the end of theStreamis the exit value is non-zero. To avoid exceptions, one can uselines_!instead.One can also start the commands in specific ways to further control their I/O. Using
!<to start the commands will use the stdin from the current process for them. All methods can be used passing a ProcessLogger to capture the output, both stderr and stdout. And, when usingrun, one can pass a ProcessIO to control stdin, stdout and stderr.The stdin of a command can be redirected from a
java.io.InputStream, ajava.io.File, ajava.net.URLor anotherProcessBuilderthrough the method#<. Likewise, the stdout can be sent to ajava.io.OutputStream, ajava.io.Fileor anotherProcessBuilderwith the method#>. The method#>>can be used to append the output to ajava.io.File. For example: