xml

xml-spac uses classes from javax.xml.stream.events to create parsing logic for XML.

The fundamental building blocks of an XML parser in xml-spac are

io.dylemma.spac.xml.XMLParser.forText for gathering text content from XML elements
io.dylemma.spac.xml.XMLParser.forMandatoryAttribute
io.dylemma.spac.xml.XMLParser.forOptionalAttribute for gathering optional attributes from XML elements
io.dylemma.spac.xml.SingleElementContextMatcher for building context matchers based on the XML element stack

There are several required implicits and optional conveniences included in this package object. You can access all of them at once via

import io.dylemma.spac.xml._

or import them individually via

import io.dylemma.spac.xml.Implicits._
import io.dylemma.spac.xml.ContextMatcherSyntax._

The imported conveniences provide methods like

ContextMatcherSyntax.elem for matching elements by name
ContextMatcherSyntax.attr for extracting element attributes as context
ContextMatcherSyntax.* and ContextMatcherSyntax.** as wildcards for element matching

Source: package.scala

Linear Supertypes

Implicits, ContextMatcherSyntax, AnyRef, Any

Type Members

trait SingleElementContextMatcher[+A] extends ContextMatcher[StartElement, A]

Specialization of ContextMatcher which only checks the first element in the stack for matching operations.
Specialization of ContextMatcher which only checks the first element in the stack for matching operations. Transformation operations on single-element matchers will yield other single-element matchers (rather than the base ContextMatcher type). Combination operations involving other single-element matchers will also yield single-element matchers. SingleElementContextMatchers form the building blocks of more complex matchers.
A
The type of the matched context.
type XMLContextMatcher[+Context] = ContextMatcher[StartElement, Context]
class XMLEvents extends AnyRef
type XMLParser[+T] = Parser[XMLEvent, T]
trait XMLResource[-T] extends AnyRef
class XMLSplitter[+Context] extends ContextStackSplitter[XMLEvent, StartElement, Context]
type XMLTransformer[+T] = Transformer[XMLEvent, T]

Value Members

val *: SingleElementContextMatcher[Unit]

Context matcher that matches any single element at the head of the tag stack.
Context matcher that matches any single element at the head of the tag stack.

Definition Classes
ContextMatcherSyntax
val **: ContextMatcher[StartElement, Unit]

Definition Classes
ContextMatcherSyntax
object ContextMatcherSyntax extends ContextMatcherSyntax

Defines XML-specific conveniences for creating ContextMatchers.
Defines XML-specific conveniences for creating ContextMatchers.
The contents of ContextMatcherSyntax are inherited by this package object, so you can choose to import them along with all of the other "syntax" helpers by importing io.dylemma.spac.xml._, or import the Implicits specifically via io.dylemma.spac.xml.ContextMatcherSyntax._.
object Implicits extends Implicits

Defines XML-specific instances for the core spac typeclasses.
Defines XML-specific instances for the core spac typeclasses.
The contents of Implicits are inherited by this package object, so you can choose to import them along with all of the other "syntax" helpers by importing io.dylemma.spac.xml._, or import the Implicits specifically via io.dylemma.spac.xml.Implicits._.
val Root: ContextMatcher[StartElement, Unit]

Context matcher that always matches without consuming any of the tag stack.
Context matcher that always matches without consuming any of the tag stack.

Definition Classes
ContextMatcherSyntax
object SingleElementContextMatcher
object XMLEvents
object XMLParser
object XMLResource
object XMLSplitter
def attr(name: String): SingleElementContextMatcher[String]

Context matcher that extracts the given attribute from the element at the head of the stack.
Context matcher that extracts the given attribute from the element at the head of the stack.
name
The local name of the attribute to extract

Definition Classes
ContextMatcherSyntax
def attr(qname: QName): SingleElementContextMatcher[String]

Context matcher that extracts the given attribute from the element at the head of the stack.
Context matcher that extracts the given attribute from the element at the head of the stack.
qname
The qualified name of the attribute to extract

Definition Classes
ContextMatcherSyntax
implicit val consumableLikeXMLEvents: ConsumableLike[XMLEvents, XMLEvent]

Implicit evidence that an XMLEvents instance can be opened as a stream of XMLEvent.
Implicit evidence that an XMLEvents instance can be opened as a stream of XMLEvent.

Definition Classes
Implicits
implicit def consumableLikeXMLResource[T](implicit arg0: XMLResource[T]): ConsumableLike[T, XMLEvent]

Implicit evidence that any value of type T can be opened as a stream of XMLEvent as long as T belongs to the XMLResource typeclass.
Implicit evidence that any value of type T can be opened as a stream of XMLEvent as long as T belongs to the XMLResource typeclass.
T
A resource type that can be treated as a stream
returns
Implicit evidence that T can be opened as a stream of XMLEvent

Definition Classes
Implicits
def elem(name: String): SingleElementContextMatcher[Unit]

Context matcher that matches the element at the head of the stack as long as its name (local part only) is equal to the given name
Context matcher that matches the element at the head of the stack as long as its name (local part only) is equal to the given name
name
The required (local) name for the element at the head of the stack

Definition Classes
ContextMatcherSyntax
def elem(qname: QName): SingleElementContextMatcher[Unit]

Context matcher that matches the element at the head of the stack as long as its name is equal to the given qname.
Context matcher that matches the element at the head of the stack as long as its name is equal to the given qname.
qname
The required name (QName) for the element at the head of the stack

Definition Classes
ContextMatcherSyntax
val extractElemName: SingleElementContextMatcher[String]

Context matcher that extracts the (local) name of the element at the head of the stack.
Context matcher that extracts the (local) name of the element at the head of the stack.

Definition Classes
ContextMatcherSyntax
val extractElemQName: SingleElementContextMatcher[QName]

Context matcher that extracts the (qualified) name of the element at the head of the stack.
Context matcher that extracts the (qualified) name of the element at the head of the stack.

Definition Classes
ContextMatcherSyntax
package handlers
implicit def qnameToElemMatcher(qname: QName): SingleElementContextMatcher[Unit]

Implicitly convert a QName to an elem matcher
Implicitly convert a QName to an elem matcher

Definition Classes
ContextMatcherSyntax
implicit def stringToElemMatcher(name: String): SingleElementContextMatcher[Unit]

Implicitly convert a String to an elem matcher
Implicitly convert a String to an elem matcher

Definition Classes
ContextMatcherSyntax
package syntax
implicit val xmlStackable: Aux[XMLEvent, StartElement]

A io.dylemma.spac.types.Stackable instance for XML, using XMLEvent as the input type, and StartElement as the context stack element type.
A io.dylemma.spac.types.Stackable instance for XML, using XMLEvent as the input type, and StartElement as the context stack element type.

Definition Classes
Implicits

package xml

Type Members

trait SingleElementContextMatcher[+A] extends ContextMatcher[StartElement, A]

type XMLContextMatcher[+Context] = ContextMatcher[StartElement, Context]

class XMLEvents extends AnyRef

type XMLParser[+T] = Parser[XMLEvent, T]

trait XMLResource[-T] extends AnyRef

class XMLSplitter[+Context] extends ContextStackSplitter[XMLEvent, StartElement, Context]

type XMLTransformer[+T] = Transformer[XMLEvent, T]

Value Members

val *: SingleElementContextMatcher[Unit]

val **: ContextMatcher[StartElement, Unit]

object ContextMatcherSyntax extends ContextMatcherSyntax

object Implicits extends Implicits

val Root: ContextMatcher[StartElement, Unit]

object SingleElementContextMatcher

object XMLEvents

object XMLParser

object XMLResource

object XMLSplitter

def attr(name: String): SingleElementContextMatcher[String]

def attr(qname: QName): SingleElementContextMatcher[String]

implicit val consumableLikeXMLEvents: ConsumableLike[XMLEvents, XMLEvent]

implicit def consumableLikeXMLResource[T](implicit arg0: XMLResource[T]): ConsumableLike[T, XMLEvent]

def elem(name: String): SingleElementContextMatcher[Unit]

def elem(qname: QName): SingleElementContextMatcher[Unit]

val extractElemName: SingleElementContextMatcher[String]

val extractElemQName: SingleElementContextMatcher[QName]

package handlers

implicit def qnameToElemMatcher(qname: QName): SingleElementContextMatcher[Unit]

implicit def stringToElemMatcher(name: String): SingleElementContextMatcher[Unit]

package syntax

implicit val xmlStackable: Aux[XMLEvent, StartElement]

Inherited from Implicits

Inherited from ContextMatcherSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped