Trait

io.dylemma.spac

ContextSensitiveHandler

Related Doc: package spac

Permalink

trait ContextSensitiveHandler[-In, -Context, +Out] extends Handler[In, Out]

Extension of the Handler trait that additionally handles entering and exiting a context. A separate component should be responsible for deciding when a context begins or ends. The combination of that decider and this handler forms the basis of a Splitter's handler.

In

The input type

Context

The context type

Out

The output type

Source
ContextSensitiveHandler.scala
Linear Supertypes
Handler[In, Out], AnyRef, Any
Known Subclasses
ContextMiddlemanHandler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContextSensitiveHandler
  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

Abstract Value Members

  1. abstract def handleContextEnd(): Option[Out]

    Permalink

    Causes this handler to process a context end.

    Causes this handler to process a context end.

    This method should not be called if isFinished == true, or if no corresponding handleContextStart was called.

    returns

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

  2. abstract def handleContextStart(context: Try[Context]): Option[Out]

    Permalink

    Causes this handler to process a context start event.

    Causes this handler to process a context start event.

    This method should not be called if isFinished == true

    context

    A Try containing the new context, or an error originating from the "context decider"

    returns

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

  3. abstract 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
    Handler

  4. abstract 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
    Handler

  5. abstract 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
    Handler

  6. abstract 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
    Handler

Concrete 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 ContextSensitiveHandler[In, Context, Out] to any2stringadd[ContextSensitiveHandler[In, Context, Out]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ContextSensitiveHandler[In, Context, Out], B)

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

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

  9. def ensuring(cond: (ContextSensitiveHandler[In, Context, Out]) ⇒ Boolean): ContextSensitiveHandler[In, Context, Out]

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ContextSensitiveHandler[In, Context, Out]

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

  11. def ensuring(cond: Boolean): ContextSensitiveHandler[In, Context, Out]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ContextSensitiveHandler[In, Context, Out] to Ensuring[ContextSensitiveHandler[In, Context, 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 ContextSensitiveHandler[In, Context, Out] to StringFormat[ContextSensitiveHandler[In, Context, 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 hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (ContextSensitiveHandler[In, Context, Out], B)

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

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

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

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

Ungrouped