Class

io.dylemma.spac.ContextMatcher

Chained

Related Doc: package ContextMatcher

Permalink

case class Chained[H, T, F](headM: ContextMatcher[H], tailM: ContextMatcher[T])(implicit reduce: Aux[H, T, F]) extends ContextMatcher[F] with Product with Serializable

Matcher implementation for headM \ tailM

H

The head result type

T

The tail result type

F

The combined result type

headM

The first matcher in the chain

tailM

The next matcher in the chain

reduce

The TypeReduce rule to combine the head and tail result types

Source
ContextMatcher.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ContextMatcher[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Chained
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ContextMatcher
  7. AnyRef
  8. 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

Instance Constructors

  1. new Chained(headM: ContextMatcher[H], tailM: ContextMatcher[T])(implicit reduce: Aux[H, T, F])

    Permalink

    headM

    The first matcher in the chain

    tailM

    The next matcher in the chain

    reduce

    The TypeReduce rule to combine the head and tail result types

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 Chained[H, T, F] to any2stringadd[Chained[H, T, F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Chained[H, T, F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to ArrowAssoc[Chained[H, T, F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def \[A1 >: F, B, R](next: ContextMatcher[B])(implicit reduce: Aux[A1, B, R]): ContextMatcher[R]

    Permalink

    Create a new matcher by forming a chain with this matcher at the front, and the next matcher at the back.

    Create a new matcher by forming a chain with this matcher at the front, and the next matcher at the back. In other words, a matcher for a context within another context.

    A1

    To satisfy covariance on A

    B

    The next matcher's context type

    R

    The "reduced" content type, derived from the tuple type (A, B) based on the reduce rule.

    next

    A matcher which will be used to match the "inner" context

    reduce

    The TypeReduce rule to help omit Unit from the resulting context type

    returns

    A matcher which delegates to this matcher first, then the next matcher for the remaining stack.

    Definition Classes
    ContextMatcher
  7. def apply(stack: IndexedSeq[StartElement], offset: Int, avail: Int): Option[F]

    Permalink

    The main context match method.

    The main context match method.

    Inspects the elements in the XML "tag stack", which is essentially a List[StartElement], but for performance reasons is represented as an array with an "offset" index and a number of available elements from that offset. If the elements correspond to a context value of A, the implementation must then pass the remaining elements of the stack to the next matcher, i.e. by calling next(stack, offset + numConsumed, avail - numConsumed).

    The difference between this method and applyChained is the lack of the next parameter; in this method, the current matcher is assumed to be the end of the chain.

    stack

    A reference to the complete XML "tag stack". Note that the responsibility of this method is limited to a *slice* of this value, as defined by offset and avail.

    offset

    The index of the first element to be considered by the matching logic. From this method's point of view, the "first" element in the stack is actually at stack(offset)

    avail

    The number of elements available in the stack starting from the offset.

    returns

    An option containing the successfully-matched context, or None.

    Definition Classes
    ChainedContextMatcher
  8. def applyChained[N](stack: IndexedSeq[StartElement], offset: Int, avail: Int, next: ContextMatcher[N]): Option[(F, N)]

    Permalink

    The underlying context match method.

    The underlying context match method.

    Inspects the elements in the XML "tag stack", which is essentially a List[StartElement], but for performance reasons is represented as an array with an "offset" index and a number of available elements from that offset. If the elements correspond to a context value of A, the implementation must then pass the remaining elements of the stack to the next matcher, i.e. by calling next(stack, offset + numConsumed, avail - numConsumed).

    The next matcher is necessary in order to support non-greedy matchers, e.g. ContextMatcher.variableLength, a.k.a. **. Without a reference to the next matcher in the chain, matcher implementations would be forced to pick a fixed number of elements for matching, never knowing that the overall match could have succeeded if they had consumed some additional elements.

    stack

    A reference to the complete XML "tag stack". Note that the responsibility of this method is limited to a *slice* of this value, as defined by offset and avail.

    offset

    The index of the first element to be considered by the matching logic. From this method's point of view, the "first" element in the stack is actually at stack(offset)

    avail

    The number of elements available in the stack starting from the offset.

    next

    The next matcher in the chain.

    returns

    If the match succeeded, and the next match succeded, an Option containing a tuple of both match results. If the match failed, or if the next match failed, None.

    Definition Classes
    ChainedContextMatcher
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (Chained[H, T, F]) ⇒ Boolean, msg: ⇒ Any): Chained[H, T, F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to Ensuring[Chained[H, T, F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Chained[H, T, F]) ⇒ Boolean): Chained[H, T, F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to Ensuring[Chained[H, T, F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Chained[H, T, F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to Ensuring[Chained[H, T, F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Chained[H, T, F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to Ensuring[Chained[H, T, F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def filter(p: (F) ⇒ Boolean): ContextMatcher[F]

    Permalink

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the validation function f.

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the validation function f. If f returns false, the match is unsuccessful.

    p

    The filter predicate, i.e. the validation function

    returns

    A new matcher with validated results

    Definition Classes
    ContextMatcher
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def flatMap[B](f: (F) ⇒ Option[B]): ContextMatcher[B]

    Permalink

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the combined transformation/validation function f.

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the combined transformation/validation function f. If f returns None, the match is unsuccessful; if f returns a Some, the value inside is the result of the match.

    B

    The transformed context type

    f

    The transformation/validation function

    returns

    A new matcher with transformed and validated results

    Definition Classes
    ContextMatcher
  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to StringFormat[Chained[H, T, F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. val headM: ContextMatcher[H]

    Permalink

    The first matcher in the chain

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def map[B](f: (F) ⇒ B): ContextMatcher[B]

    Permalink

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the transformation function f.

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the transformation function f.

    B

    The transformed context type

    f

    The transformation function

    returns

    A new matcher with transformed results

    Definition Classes
    ContextMatcher
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def or[A2 >: F](that: ContextMatcher[A2]): ContextMatcher[A2]

    Permalink

    Create a new ContextMatcher which will fall back to a second matcher in the event that this matcher fails to match a context.

    Create a new ContextMatcher which will fall back to a second matcher in the event that this matcher fails to match a context.

    A2

    The resulting context type (common supertype between this matcher and that)

    that

    The matcher which will be used as the fallback

    returns

    A matcher that falls back to another matcher in case of failure

    Definition Classes
    ContextMatcher
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. val tailM: ContextMatcher[T]

    Permalink

    The next matcher in the chain

  30. def toString(): String

    Permalink
    Definition Classes
    Chained → AnyRef → Any
  31. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def |[A2 >: F](that: ContextMatcher[A2]): ContextMatcher[A2]

    Permalink

    Operator version of or

    Operator version of or

    Definition Classes
    ContextMatcher
  35. def [B](y: B): (Chained[H, T, F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chained[H, T, F] to ArrowAssoc[Chained[H, T, F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ContextMatcher[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Chained[H, T, F] to any2stringadd[Chained[H, T, F]]

Inherited by implicit conversion StringFormat from Chained[H, T, F] to StringFormat[Chained[H, T, F]]

Inherited by implicit conversion Ensuring from Chained[H, T, F] to Ensuring[Chained[H, T, F]]

Inherited by implicit conversion ArrowAssoc from Chained[H, T, F] to ArrowAssoc[Chained[H, T, F]]

Ungrouped