scala.sys.process

ProcessBuilder

trait ProcessBuilder extends Source with Sink

Represents a runnable process.

Source
ProcessBuilder.scala
Linear Supertypes
Sink, Source, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ProcessBuilder
  2. Sink
  3. Source
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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.

    Attributes
    abstract
  2. 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.

    Attributes
    abstract
  3. 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.

    Attributes
    abstract
  4. 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.

    Attributes
    abstract
  5. 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.

    Attributes
    abstract
  6. 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.

    Attributes
    abstract
  7. 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.

    Attributes
    abstract
  8. def #&& (other: ProcessBuilder): ProcessBuilder

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

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

    Attributes
    abstract
  9. 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.

    Attributes
    abstract
  10. def #|| (other: ProcessBuilder): ProcessBuilder

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

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

    Attributes
    abstract
  11. def canPipeTo : Boolean

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

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

    Attributes
    abstract
  12. 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.

    Attributes
    abstract
  13. def lines (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.

    Attributes
    abstract
  14. def lines : 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.

    Attributes
    abstract
  15. def lines_! (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.

    Attributes
    abstract
  16. def lines_! : 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.

    Attributes
    abstract
  17. 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.

    Attributes
    abstract
  18. 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.

    Attributes
    abstract
  19. 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.

    Attributes
    abstract
  20. 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.

    Attributes
    abstract
  21. 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.

    Attributes
    abstract
  22. def toSink : ProcessBuilder

    Attributes
    protected abstract
    Definition Classes
    Sink
  23. def toSource : ProcessBuilder

    Attributes
    protected abstract
    Definition Classes
    Source

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

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

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. 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.

    returns

    a hash value consistent with ==

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def #< (b: ProcessBuilder): ProcessBuilder

    Definition Classes
    Sink
  5. 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
  6. 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
  7. 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
  8. def #> (b: ProcessBuilder): ProcessBuilder

    Definition Classes
    Source
  9. 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
  10. 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
  11. 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
  12. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  13. def == (arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

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

    Attributes
    final
    Definition Classes
    Any
  14. 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.

    Attributes
    final
    Definition Classes
    Any
  15. def cat : ProcessBuilder

    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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. 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.

    Attributes
    final
    Definition Classes
    AnyRef
  18. def equals (arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    returns

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

    Definition Classes
    AnyRef → Any
  19. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  20. def getClass (): java.lang.Class[_ <: java.lang.Object]

    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.

    Attributes
    final
    Definition Classes
    AnyRef
  21. def hashCode (): Int

    The hashCode method for reference types.

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

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  22. 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.

    Attributes
    final
    Definition Classes
    Any
  23. 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.

    Attributes
    final
    Definition Classes
    AnyRef
  24. 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.

    Attributes
    final
    Definition Classes
    AnyRef
  25. 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.

    Attributes
    final
    Definition Classes
    AnyRef
  26. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  27. 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
  28. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  29. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Sink

Inherited from Source

Inherited from AnyRef

Inherited from Any