io.dylemma.spac

Handler

trait Handler[-In, +Out] extends AnyRef

The base processing unit for dealing with streams of data.

A handler accepts inputs of type In, eventually yielding a value of type Out. If the handleInput or handleError methods for a handler ever return a Some, it implies that the handler has reached a result, and should no longer be called. Similarly, if the isFinished method returns true, the handleX methods should no longer be called.

Handlers are mutable by nature. Handler instances should not be shared across threads. Several traits in this library act as "blueprints" which create handler instances. These blueprint classes are immutable, and may be safely shared across threads.

In

The input type

Out

The output type

Source
Handler.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Handler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def handleEnd(): Out

    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

  2. abstract def handleError(error: Throwable): Option[Out]

    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.

  3. abstract def handleInput(input: In): Option[Out]

    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.

  4. abstract def isFinished: Boolean

    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

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Definition Classes
    AnyRef → Any
  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
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped