Class

work.martins.simon.expect.fluent

EndOfFileWhen

Related Doc: package fluent

Permalink

case class EndOfFileWhen[R](parent: ExpectBlock[R]) extends When[R] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, When[R], Whenable[R], Expectable[R], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndOfFileWhen
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. When
  7. Whenable
  8. Expectable
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EndOfFileWhen(parent: ExpectBlock[R])

    Permalink

Type Members

  1. type CW[X] = core.EndOfFileWhen[X]

    Permalink

    The concrete core.When type constructor which this fluent.When is a builder for.

    The concrete core.When type constructor which this fluent.When is a builder for.

    Definition Classes
    EndOfFileWhenWhen
  2. type This[X] = EndOfFileWhen[X]

    Permalink

    The concrete When type constructor to which the actions will be applied.

    The concrete When type constructor to which the actions will be applied.

    Definition Classes
    EndOfFileWhenWhen

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to any2stringadd[EndOfFileWhen[R]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EndOfFileWhen[R], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to ArrowAssoc[EndOfFileWhen[R]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. var actions: Seq[Action[R, CW]]

    Permalink
    Attributes
    protected
    Definition Classes
    When
  7. def addActions(f: (This[R]) ⇒ Unit): This[R]

    Permalink

    Add arbitrary Actions to this When.

    Add arbitrary Actions to this When.

    This is helpful to refactor code. For example: imagine you want to perform the same actions whenever an error occurs. You could leverage this method to do so in the following way:

    def preemtiveExit(when: When[String]): Unit {
      when
        .returning("Got some error")
        .exit()
    }
    
    def parseOutputA: Expect[String] = {
      val e = new Expect("some command", "")
      e.expect
        .when(...)
          .action1
        .when(...)
          .addActions(preemtiveExit)
    }
    
    def parseOutputB: Expect[String] = {
      val e = new Expect("some command", "")
      e.expect(...)
        .addActions(preemtiveExit)
    }
    f

    function that adds Actions.

    returns

    this When.

    Definition Classes
    When
  8. def addExpectBlock(f: (Expect[R]) ⇒ Unit): Expect[R]

    Permalink

    Add arbitrary ExpectBlocks to this Expect.

    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
    Expectable
  9. def addWhen[W <: When[R]](f: (ExpectBlock[R]) ⇒ W): W

    Permalink

    Add an arbitrary When to this ExpectBlock.

    Add an arbitrary When to this ExpectBlock.

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

    def errorCaseWhen(expectBlock: ExpectBlock[String]): When[String] = {
      expectBlock
        .when("Some error")
          .returning("Got some error")
    }
    
    def parseOutputA: Expect[String] = {
      val e = new Expect("some command", "")
      e.expect
        .when(...)
          .sendln(...)
      e.expect
        .addWhen(errorCaseWhen)
          .exit()
    }
    
    def parseOutputB: Expect[String] = {
      val e = new Expect("some command", "")
      e.expect
        .when(...)
          .sendln(..)
          .returning(...)
        .addWhen(errorCaseWhen)
    }

    This function returns the added When which allows you to add further actions, see the exit action of the parseOutputA method in the above code.

    It is possible to add more than one When using this method, however this is discouraged since it will make the code somewhat more illegible because "hidden" Whens will also be added.

    If you need to add more than one When you have two options:

    e.expect
      .when(...)
         .sendln(..)
         .returning(...)
      .addWhen(errorCaseWhen)
      .addWhen(anotherWhen)
    e.expect
      .when(...)
         .sendln(..)
         .returning(...)
      .addWhens(multipleWhens)
    f

    function that adds the When.

    returns

    the added When.

    Definition Classes
    Whenable
  10. def addWhens(f: (ExpectBlock[R]) ⇒ Unit): ExpectBlock[R]

    Permalink

    Add arbitrary Whens to this ExpectBlock.

    Add arbitrary Whens to this ExpectBlock.

    This method is very similar to the addWhen with the following differences:

    1. f has a more relaxed type.
    2. It returns this ExpectBlock. Which effectively prohibits you from invoking When methods.
    3. Has a more semantic name when it comes to adding multiple When's.
    f

    function that adds Whens.

    returns

    this ExpectBlock.

    Definition Classes
    Whenable
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def ensuring(cond: (EndOfFileWhen[R]) ⇒ Boolean, msg: ⇒ Any): EndOfFileWhen[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to Ensuring[EndOfFileWhen[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (EndOfFileWhen[R]) ⇒ Boolean): EndOfFileWhen[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to Ensuring[EndOfFileWhen[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): EndOfFileWhen[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to Ensuring[EndOfFileWhen[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): EndOfFileWhen[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to Ensuring[EndOfFileWhen[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(other: Any): Boolean

    Permalink
    Definition Classes
    EndOfFileWhen → Equals → AnyRef → Any
  19. def exit(): This[R]

    Permalink

    Terminates the current run of Expect causing it to return the last returned value.

    Terminates the current run of Expect causing it to return the last returned value. Any action or expect block added after this Exit will not be executed.

    returns

    this When.

    Definition Classes
    When
  20. def expect(pattern: EndOfFile.type): EndOfFileWhen[R]

    Permalink

    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
  21. def expect(pattern: Timeout.type): TimeoutWhen[R]

    Permalink

    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
  22. def expect(pattern: Regex): RegexWhen[R]

    Permalink

    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
  23. def expect(pattern: String): StringWhen[R]

    Permalink

    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
  24. def expect: ExpectBlock[R]

    Permalink

    Adds an empty new ExpectBlock.

    Adds an empty new ExpectBlock.

    returns

    the new ExpectBlock.

    Definition Classes
    Expectable
  25. val expectableParent: Expectable[R]

    Permalink
    Attributes
    protected
    Definition Classes
    WhenExpectable
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to StringFormat[EndOfFileWhen[R]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def hashCode(): Int

    Permalink
    Definition Classes
    EndOfFileWhen → AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  32. def newAction(action: Action[R, CW]): This[R]

    Permalink
    Attributes
    protected
    Definition Classes
    When
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. val parent: ExpectBlock[R]

    Permalink
    Definition Classes
    EndOfFileWhenWhen
  36. def returning(result: ⇒ R): This[R]

    Permalink

    Returns result when this Expect is run.

    Returns result when this Expect is run. If this method is invoked more than once only the last result will be returned. Note however that the previous returning actions will also be executed.

    returns

    this When.

    Definition Classes
    When
  37. def returningExpect(result: ⇒ core.Expect[R]): This[R]

    Permalink
    Definition Classes
    When
  38. def send(text: String): This[R]

    Permalink

    Send text to the stdIn of the underlying process.

    Send text to the stdIn of the underlying process. Send will only occur when Expect is run.

    returns

    this When.

    Definition Classes
    When
  39. def sendln(text: String): This[R]

    Permalink

    Sends text terminated with System.lineSeparator() to the stdIn of the underlying process.

    Sends text terminated with System.lineSeparator() to the stdIn of the underlying process. Send will only occur when Expect is run.

    returns

    this When.

    Definition Classes
    When
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  41. val thisSubtype: This[R]

    Permalink
    Definition Classes
    When
  42. def toCore: core.EndOfFileWhen[R]

    Permalink

    returns

    the core.When equivalent of this fluent.When.

    Definition Classes
    EndOfFileWhenWhen
  43. def toString(): String

    Permalink
    Definition Classes
    EndOfFileWhen → AnyRef → Any
  44. def toString(pattern: String): String

    Permalink
    Definition Classes
    When
  45. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def when(pattern: Timeout.type): TimeoutWhen[R]

    Permalink

    Adds a new TimeoutWhen that matches whenever a Timeout in thrown while trying to read text from the process output (stdOut).

    Adds a new TimeoutWhen that matches whenever a Timeout in thrown while trying to read text from the process output (stdOut).

    pattern

    the pattern to match against.

    returns

    the new TimeoutWhen.

    Definition Classes
    Whenable
  49. def when(pattern: EndOfFile.type): EndOfFileWhen[R]

    Permalink

    Adds a new EndOfFileWhen that matches whenever the EndOfFile in the process output (stdOut) is reached.

    Adds a new EndOfFileWhen that matches whenever the EndOfFile in the process output (stdOut) is reached.

    pattern

    the pattern to match against.

    returns

    the new EndOfFileWhen.

    Definition Classes
    Whenable
  50. def when(pattern: Regex): RegexWhen[R]

    Permalink

    Adds a new RegexWhen that matches whenever the regex pattern successfully matches against the text read from the process output (stdOut).

    Adds a new RegexWhen that matches whenever the regex pattern successfully matches against the text read from the process output (stdOut).

    pattern

    the pattern to match against.

    returns

    the new RegexWhen.

    Definition Classes
    Whenable
  51. def when(pattern: String): StringWhen[R]

    Permalink

    Adds a new StringWhen that matches whenever pattern is contained in the text read from the process output (stdOut).

    Adds a new StringWhen that matches whenever pattern is contained in the text read from the process output (stdOut).

    pattern

    the pattern to match against.

    returns

    the new StringWhen.

    Definition Classes
    Whenable
  52. val whenableParent: Whenable[R]

    Permalink
    Attributes
    protected
    Definition Classes
    WhenWhenable
  53. def [B](y: B): (EndOfFileWhen[R], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EndOfFileWhen[R] to ArrowAssoc[EndOfFileWhen[R]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from When[R]

Inherited from Whenable[R]

Inherited from Expectable[R]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EndOfFileWhen[R] to any2stringadd[EndOfFileWhen[R]]

Inherited by implicit conversion StringFormat from EndOfFileWhen[R] to StringFormat[EndOfFileWhen[R]]

Inherited by implicit conversion Ensuring from EndOfFileWhen[R] to Ensuring[EndOfFileWhen[R]]

Inherited by implicit conversion ArrowAssoc from EndOfFileWhen[R] to ArrowAssoc[EndOfFileWhen[R]]

Ungrouped