Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package dylemma
    Definition Classes
    io
  • package spac

    SPaC (short for "Streaming Parser Combinators") is a library for building stream consumers in a declarative style, specialized for tree-like data types like XML and JSON.

    SPaC (short for "Streaming Parser Combinators") is a library for building stream consumers in a declarative style, specialized for tree-like data types like XML and JSON.

    Many utilities for handling XML and JSON data involve parsing the entire "document" to some DOM model, then inspecting and transforming that model to extract information. The downside to these utilities is that when the document is very large, the DOM may not fit in memory. The workaround for this type of problem is to treat the document as a stream of "events", e.g. "StartElement" and "EndElement" for XML, or "StartObject" and "EndObject" for JSON. The downside to this workaround is that writing code to handle these streams can be complicated and error-prone, especially when the DOM is complicated.

    SPaC's goal is to drastically simplify the process of creating code to handle these streams.

    This package contains the "core" SPaC traits; Parser, Transformer, Splitter, and ContextMatcher.

    See the xml and json subpackages (provided by the xml-spac and json-spac libraries respectively) for specific utilities related to handling XML and JSON event streams.

    Definition Classes
    dylemma
  • object Transformer

    Definition Classes
    spac
  • BoundHandler
  • Handler
  • HandlerLinkage
  • HandlerWrite
  • Stateless
  • TransformerKVParsingOps
  • TransformerParsingOps

trait BoundHandler[-In] extends HandlerWrite[In]

A Handler which has been bound to some "downstream" receiver of outputs, so that the push and finish methods will delegate to that downstream rather than requiring a downstream receiver to be passed as a method parameter.

In

The handler's input type

Source
Transformer.scala
Linear Supertypes
HandlerWrite[In], AnyRef, Any
Known Subclasses
ToBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BoundHandler
  2. HandlerWrite
  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. Protected

Abstract Value Members

  1. abstract def finish(): Unit

    In response to the end of the stream of incoming values, this handler may output any number of final output values to its bound "downstream" receiver.

    In response to the end of the stream of incoming values, this handler may output any number of final output values to its bound "downstream" receiver. The expectation is that a Handler's finish method will only ever be called once before that Handler is discarded, with the exception of Stateless Transformers, which act as their own Handlers and will be reused.

  2. abstract def push(out: In): Signal

    Handle a single output from the upstream handler, signalling whether or not that upstream should continue emitting values.

    Handle a single output from the upstream handler, signalling whether or not that upstream should continue emitting values.

    out

    The value from the upstream handler

    returns

    A "signal" indicating whether this handler wants to continue receiving inputs afterward

    Definition Classes
    HandlerWrite

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toany2stringadd[BoundHandler[In]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BoundHandler[In], B)
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toArrowAssoc[BoundHandler[In]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (BoundHandler[In]) => Boolean, msg: => Any): BoundHandler[In]
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toEnsuring[BoundHandler[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (BoundHandler[In]) => Boolean): BoundHandler[In]
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toEnsuring[BoundHandler[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): BoundHandler[In]
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toEnsuring[BoundHandler[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): BoundHandler[In]
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toEnsuring[BoundHandler[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def pushMany(outs: Iterator[In]): Signal

    Convenience for calling push multiple times, aborting early if the signal becomes Stop in response to any one push.

    Convenience for calling push multiple times, aborting early if the signal becomes Stop in response to any one push.

    outs

    An iterator of outputs from the upstream handler, to be pushed into this handler

    returns

    A "signal" indicating whether this handler wants to continue receiving inputs afterward

    Definition Classes
    HandlerWrite
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toStringFormat[BoundHandler[In]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (BoundHandler[In], B)
    Implicit
    This member is added by an implicit conversion from BoundHandler[In] toArrowAssoc[BoundHandler[In]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from HandlerWrite[In]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBoundHandler[In] to any2stringadd[BoundHandler[In]]

Inherited by implicit conversion StringFormat fromBoundHandler[In] to StringFormat[BoundHandler[In]]

Inherited by implicit conversion Ensuring fromBoundHandler[In] to Ensuring[BoundHandler[In]]

Inherited by implicit conversion ArrowAssoc fromBoundHandler[In] to ArrowAssoc[BoundHandler[In]]

Ungrouped