Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package github
    Definition Classes
    io
  • package vigoo
    Definition Classes
    github
  • package prox

    Provides classes to work with system processes in a type safe way.

    Provides classes to work with system processes in a type safe way.

    Refer to the user guide for more information.

    A process to be executed is represented by the Process trait. Once it has finished running the results are in ProcessResult. We call a group of processes attached together a process group, represented by ProcessGroup, its result is described by ProcessGroupResult.

    Redirection of input, output and error is enabled by the RedirectableInput, RedirectableOutput and RedirectableError trait for single processes, and the RedirectableErrors trait for process groups.

    Processes and process groups are executed by a ProcessRunner, the default implementation is called JVMProcessRunner.

    Definition Classes
    vigoo
  • trait ProcessModule extends AnyRef
    Definition Classes
    prox
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult
t

io.github.vigoo.prox.ProcessModule

ProcessConfiguration

trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

The capability to configure process execution details

Self Type
Prox.Process[_, _]
Linear Supertypes
Prox.ProcessLikeConfiguration, AnyRef, Any
Known Subclasses
Process, ProcessImpl, ProcessImplE, ProcessImplI, ProcessImplIE, ProcessImplIO, ProcessImplIOE, ProcessImplO, ProcessImplOE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessConfiguration
  2. ProcessLikeConfiguration
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Self <: Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessLikeConfiguration

Abstract Value Members

  1. abstract val environmentVariables: Map[String, String]
    Definition Classes
    ProcessLikeConfiguration
  2. abstract val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessLikeConfiguration
  3. abstract def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Process.Self
    Attributes
    protected
  4. abstract val workingDirectory: Option[Path]
    Definition Classes
    ProcessLikeConfiguration

Concrete 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 applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Process.Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def in(workingDirectory: Path): Process.Self

    Changes the working directory of the process

    Changes the working directory of the process

    workingDirectory

    the working directory

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  12. def inInheritedWorkingDirectory(): Process.Self

    Use the inherited working directory of the process instead of an explicit one

    Use the inherited working directory of the process instead of an explicit one

    returns

    a new process with the working directory cleared

    Definition Classes
    ProcessLikeConfiguration
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. def with(nameValuePair: (String, String)): Process.Self

    Adds an environment variable to the process

    Adds an environment variable to the process

    nameValuePair

    A pair of name and value

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  23. def withArguments(newArguments: List[String]): Process.Self

    Replaces the arguments

    Replaces the arguments

    newArguments

    new list of arguments

    returns

    returns a new process specification

  24. def withCommand(newCommand: String): Process.Self

    Replaces the command

    Replaces the command

    newCommand

    new value for the command to be executed

    returns

    returns a new process specification

  25. def without(name: String): Process.Self

    Removes an environment variable from the process

    Removes an environment variable from the process

    Usable to remove variables inherited from the parent process.

    name

    Name of the environment variable

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Prox.ProcessLikeConfiguration

Inherited from AnyRef

Inherited from Any

Ungrouped