Class

io.dylemma.spac.handlers

CompoundHandler

Related Doc: package handlers

Permalink

class CompoundHandler[In, B, Out] extends Handler[In, Out]

A composition of a number of "inner" handlers which delegates each event to each (unfinished) inner handler, then reforms a final result based on the final results of each of the inner handlers.

Used internally by ParserChain

In

The input type for each of the inner handlers

B

A base type for the results of all of the innerHandlers. This will typically be Any or Result[Any].

Out

The type of the final combined result

Source
CompoundHandler.scala
Linear Supertypes
Handler[In, Out], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CompoundHandler
  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 CompoundHandler(innerHandlers: IndexedSeq[Handler[In, B]], reform: (IndexedSeq[B]) ⇒ Out)

    Permalink

    innerHandlers

    An indexed collection if inner handlers. All events passed through the CompoundHandler will be passed through each (unfinished) innerHandler.

    reform

    A function to convert the result values of the inner handlers to some concrete value. The input to this function will be an array containing results from the inner handlers. The result for innerHandlers(n) will be located at the n'th index in the array. Note that the array will have values of type B, but actual values are likely intended to have more specific types, so the reform function will likely need to perform class casting.

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from CompoundHandler[In, B, Out] to ArrowAssoc[CompoundHandler[In, B, 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: (CompoundHandler[In, B, Out]) ⇒ Boolean, msg: ⇒ Any): CompoundHandler[In, B, Out]

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from CompoundHandler[In, B, Out] to Ensuring[CompoundHandler[In, B, 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 CompoundHandler[In, B, Out] to StringFormat[CompoundHandler[In, B, 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
    CompoundHandlerHandler
  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
    CompoundHandlerHandler
  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
    CompoundHandlerHandler
  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
    CompoundHandlerHandler
  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. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from CompoundHandler[In, B, Out] to ArrowAssoc[CompoundHandler[In, B, 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 CompoundHandler[In, B, Out] to any2stringadd[CompoundHandler[In, B, Out]]

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

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

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

Ungrouped