io.dylemma.spac

ContextSensitiveHandler

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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ContextSensitiveHandler
  2. Handler
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    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]

    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

    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]

    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]

    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

    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: AnyRef): Boolean

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

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

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

    Implicit information
    This member is added by an implicit conversion from ContextSensitiveHandler[In, Context, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ContextSensitiveHandler[In, Context, Out], B)

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

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

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

    Definition Classes
    Any
  9. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  25. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (ContextSensitiveHandler[In, Context, Out], B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ContextSensitiveHandler[In, Context, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (contextSensitiveHandler: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ContextSensitiveHandler[In, Context, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (contextSensitiveHandler: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ContextSensitiveHandler[In, Context, Out]

    Implicit information
    This member is added by an implicit conversion from ContextSensitiveHandler[In, Context, Out] to ArrowAssoc[ContextSensitiveHandler[In, Context, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (contextSensitiveHandler: ArrowAssoc[ContextSensitiveHandler[In, Context, Out]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ContextSensitiveHandler[In, Context, Out]

    Implicit information
    This member is added by an implicit conversion from ContextSensitiveHandler[In, Context, Out] to Ensuring[ContextSensitiveHandler[In, Context, Out]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (contextSensitiveHandler: Ensuring[ContextSensitiveHandler[In, Context, Out]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Handler[In, Out]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped