scala.sys.process

ProcessBuilder

trait ProcessBuilder extends Source with Sink

Represents a runnable process.

Represents a runnable process.

go to: companion
linear super types: Sink, Source, AnyRef, Any
source: ProcessBuilder.scala
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
Impl.
  1. Concrete
  2. 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 != ( arg0 : AnyRef ) : Boolean

    attributes: final
    definition classes: AnyRef
  8. def != ( arg0 : Any ) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

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

    attributes: final
    definition classes: Any
  9. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  10. 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
  11. 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
  12. def #< ( b : ProcessBuilder ) : ProcessBuilder

    definition classes: Sink
  13. 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
  14. 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
  15. 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
  16. def #> ( b : ProcessBuilder ) : ProcessBuilder

    definition classes: Source
  17. 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
  18. 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
  19. 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
  20. 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
  21. 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
  22. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  23. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  24. def == ( arg0 : AnyRef ) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  25. def == ( arg0 : Any ) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: Any
  26. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to 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 typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  27. 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
  28. def cat : ProcessBuilder

    definition classes: Source
  29. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns 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()
  30. def daemonized () : ProcessBuilder

    Constructs a new builder which runs this command with all input/output threads marked as daemon threads.

    Constructs a new builder which runs this command with all input/output threads marked as daemon threads. This allows the creation of a long running process while still allowing the JVM to exit normally.

    attributes: abstract
  31. def eq ( arg0 : AnyRef ) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other 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).

    arg0

    the object to compare against this object for reference equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  32. def equals ( arg0 : Any ) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    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
  33. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are 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()
  34. def getClass () : java.lang.Class[_ <: java.lang.Object]

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

    Returns 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
  35. 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
  36. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  37. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test 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 requested typed.

    returns

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

    attributes: final
    definition classes: Any
  38. 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
  39. 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
  40. 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
  41. 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
  42. def ne ( arg0 : AnyRef ) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  43. 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
  44. 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
  45. 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
  46. 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
  47. 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
  48. 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
  49. 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
  50. def synchronized [T0] ( arg0 : ⇒ T0 ) : T0

    attributes: final
    definition classes: AnyRef
  51. def toSink : ProcessBuilder

    attributes: protected abstract
    definition classes: Sink
  52. def toSource : ProcessBuilder

    attributes: protected abstract
    definition classes: Source
  53. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  54. def wait () : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  55. def wait ( arg0 : Long , arg1 : Int ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  56. def wait ( arg0 : Long ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()

Inherited from Sink

Inherited from Source

Inherited from AnyRef

Inherited from Any