Expect

Instance Constructors

new Expect(command: String, defaultValue: R)
new Expect(command: String, defaultValue: R, config: Config)
new Expect(command: String, defaultValue: R, settings: Settings)
new Expect(command: Seq[String], defaultValue: R, config: Config)
new Expect(command: Seq[String], defaultValue: R, settings: Settings = new Settings())

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any

def addExpectBlock(f: (Expect[R]) ⇒ Unit): Expect[R]

Add arbitrary ExpectBlocks to this Expect.

This is helpful to refactor code. For example: imagine you have an error case you want to add to multiple expects. You could leverage this method to do so in the following way:

def errorCaseExpectBlock(expect: Expect[String]): Unit {
  expect.expect
    .when("Some error")
      .returning("Got some error")
}

//Then in your expects
def parseOutputA: Expect[String] = {
  val e = new Expect("some command", "")
  e.expect(...)
  e.expect
    .when(...)
      .action1
    .when(...)
      .action2
  e.addExpectBlock(errorCaseExpectBlock)
}

def parseOutputB: Expect[String] = {
  val e = new Expect("some command", "")
  e.expect
    .when(...)
      .action1
      .action2
    .when(...)
      .action1
  e.expect(...)
    .action2
  e.addExpectBlock(errorCaseExpectBlock)
}

f: function that adds ExpectBlocks.
returns: this Expect.

Definition Classes: Expect → Expectable

final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val command: Seq[String]
val defaultValue: R
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
Expect → AnyRef → Any
def expect: ExpectBlock[R]

Adds an empty new ExpectBlock.
Adds an empty new ExpectBlock.
returns
the new ExpectBlock.

Definition Classes
Expect → Expectable
def expect(pattern: EndOfFile.type): EndOfFileWhen[R]

Adds, in a new ExpectBlock, a EndOfFileWhen that matches whenever the end of file is reached while trying to read from the process output (stdOut).
Adds, in a new ExpectBlock, a EndOfFileWhen that matches whenever the end of file is reached while trying to read from the process output (stdOut). This is a shortcut to expect.when(pattern).
pattern
the pattern to be used in the EndOfFileWhen.
returns
the new RegexWhen.

Definition Classes
Expectable
def expect(pattern: Timeout.type): TimeoutWhen[R]

Adds, in a new ExpectBlock, a TimeoutWhen that matches whenever the read from the process output (stdOut) times out.
Adds, in a new ExpectBlock, a TimeoutWhen that matches whenever the read from the process output (stdOut) times out. This is a shortcut to expect.when(pattern).
pattern
the pattern to be used in the TimeoutWhen.
returns
the new RegexWhen.

Definition Classes
Expectable
def expect(pattern: Regex): RegexWhen[R]

Adds, in a new ExpectBlock, a RegexWhen that matches whenever the regex pattern successfully matches against the text read from the process output (stdOut).
Adds, in a new ExpectBlock, a RegexWhen that matches whenever the regex pattern successfully matches against the text read from the process output (stdOut). This is a shortcut to expect.when(pattern).
pattern
the pattern to be used in the RegexWhen.
returns
the new RegexWhen.

Definition Classes
Expectable
def expect(pattern: String): StringWhen[R]

Adds, in a new ExpectBlock, a StringWhen that matches whenever pattern is contained in the text read from the process output (stdOut).
Adds, in a new ExpectBlock, a StringWhen that matches whenever pattern is contained in the text read from the process output (stdOut). This is a shortcut to expect.when(pattern).
pattern
the pattern to be used in the StringWhen.
returns
the new StringWhen.

Definition Classes
Expectable
val expectableParent: Expectable[R]

Attributes
protected
Definition Classes
Expect → Expectable
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
Expect → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def run(timeout: FiniteDuration = timeout, charset: Charset = charset, bufferSize: Int = bufferSize, redirectStdErrToStdOut: Boolean = redirectStdErrToStdOut)(implicit ex: ExecutionContext): Future[R]

Runs this Expect.
Runs this Expect.
timeout
the maximum time to wait for each read.
charset
the charset to use when decoding/encoding the read/write text.
bufferSize
the size of the buffer to use when performing reads.
redirectStdErrToStdOut
whether to redirect the stdErr of the spawned process to the stdOut.
ex
the ExecutionContext upon which this Expect will be run.
returns
a Future with the value returned by a ReturningAction, if no ReturningAction exists defaultValue will be returned. If an exception occurred during the execution of the future then that exception will be returned in the Failure of the Future.

Definition Classes
Expect → Runnable
val runnableParent: Runnable[R]

Attributes
protected
Definition Classes
Expect → Runnable
val settings: Settings

Definition Classes
Expect → Runnable
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toCore: core.Expect[R]

returns
the core.Expect equivalent of this fluent.Expect.
def toString(): String

Definition Classes
Expect → AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package fluent

class Expect[R] extends Runnable[R] with Expectable[R]

Instance Constructors

new Expect(command: String, defaultValue: R)

new Expect(command: String, defaultValue: R, config: Config)

new Expect(command: String, defaultValue: R, settings: Settings)

new Expect(command: Seq[String], defaultValue: R, config: Config)

new Expect(command: Seq[String], defaultValue: R, settings: Settings = new Settings())

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addExpectBlock(f: (Expect[R]) ⇒ Unit): Expect[R]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val command: Seq[String]

val defaultValue: R

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def expect: ExpectBlock[R]

def expect(pattern: EndOfFile.type): EndOfFileWhen[R]

def expect(pattern: Timeout.type): TimeoutWhen[R]

def expect(pattern: Regex): RegexWhen[R]

def expect(pattern: String): StringWhen[R]

val expectableParent: Expectable[R]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def run(timeout: FiniteDuration = timeout, charset: Charset = charset, bufferSize: Int = bufferSize, redirectStdErrToStdOut: Boolean = redirectStdErrToStdOut)(implicit ex: ExecutionContext): Future[R]

val runnableParent: Runnable[R]

val settings: Settings

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

def toCore: core.Expect[R]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Expectable[R]

Inherited from Runnable[R]

Inherited from AnyRef

Inherited from Any

Ungrouped