Class

io.dylemma.spac.handlers

ExpectationSequenceHandler

Related Doc: package handlers

Permalink

class ExpectationSequenceHandler[In, Out] extends Handler[In, Out]

Wrapper for a downstream handler which will enforce an expectation of a specific sequence of events (as expressed by expectations). If an input comes in that doesn't meet the expectations, or an EOF is received before all of the expected inputs are encountered, this wrapper will send an error downstream.

In

The input type

Out

The output type

Source
ExpectationSequenceHandler.scala
Linear Supertypes
Handler[In, Out], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExpectationSequenceHandler
  2. Handler
  3. AnyRef
  4. 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 ExpectationSequenceHandler(expectations: List[(String, (In) ⇒ Boolean)], downstream: Handler[In, Out])

    Permalink

    expectations

    A list containing a series of "label -> test" values representing the input expectations

    downstream

    The wrapped handler

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 ExpectationSequenceHandler[In, Out] to any2stringadd[ExpectationSequenceHandler[In, Out]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ExpectationSequenceHandler[In, Out], B)

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (ExpectationSequenceHandler[In, Out]) ⇒ Boolean, msg: ⇒ Any): ExpectationSequenceHandler[In, Out]

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ExpectationSequenceHandler[In, Out] to Ensuring[ExpectationSequenceHandler[In, Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ExpectationSequenceHandler[In, Out]

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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def handleEnd(): Out

    Permalink

    Causes this handler to finalize and produce a result.

    Causes this handler to finalize and produce a result.

    This method should not be called if isFinished is already true.

    returns

    The final output of this parser

    Definition Classes
    ExpectationSequenceHandlerHandler
  18. def handleError(error: Throwable): Option[Out]

    Permalink

    Causes this handler to process an error.

    Causes this handler to process an error.

    This method should not be called if isFinished == true

    error

    an error to be processed

    returns

    An option containing the final output if this handler became finished as a result of processing the error, or None if the handler is ready for more input.

    Definition Classes
    ExpectationSequenceHandlerHandler
  19. def handleInput(input: In): Option[Out]

    Permalink

    Causes this handler to process an input element.

    Causes this handler to process an input element.

    This method should not be called if isFinished == true

    input

    an element to be processed

    returns

    An option containing the final output if this handler became finished as a result of processing the input, or None if the handler is ready for more input.

    Definition Classes
    ExpectationSequenceHandlerHandler
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def isFinished: Boolean

    Permalink

    Tells if this handler is finished.

    Tells if this handler is finished.

    If a handler is finished, its handleX methods should no longer be called. Doing so after the handler finishes will cause undefined behavior. Typically a handler should be discarded once it is finished.

    returns

    whether this handler is finished

    Definition Classes
    ExpectationSequenceHandlerHandler
  22. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  26. var remainingExpectations: List[(String, (In) ⇒ Boolean)]

    Permalink
    Attributes
    protected
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (ExpectationSequenceHandler[In, Out], B)

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

Inherited from Handler[In, Out]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ExpectationSequenceHandler[In, Out] to any2stringadd[ExpectationSequenceHandler[In, Out]]

Inherited by implicit conversion StringFormat from ExpectationSequenceHandler[In, Out] to StringFormat[ExpectationSequenceHandler[In, Out]]

Inherited by implicit conversion Ensuring from ExpectationSequenceHandler[In, Out] to Ensuring[ExpectationSequenceHandler[In, Out]]

Inherited by implicit conversion ArrowAssoc from ExpectationSequenceHandler[In, Out] to ArrowAssoc[ExpectationSequenceHandler[In, Out]]

Ungrouped