Trait

laika.ast

ElementTraversal

Related Doc: package ast

Permalink

trait ElementTraversal[Self <: Element with ElementTraversal[Self]] extends AnyRef

Provides means to traverse, select and rewrite elements of a document tree. This trait can get mixed in by any element node, not just the root Document class, therefore providing traversal for any kind of sub-tree, too.

Self Type
ElementTraversal[Self] with Element
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ElementTraversal
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class RewriteException extends RuntimeException

    Permalink

    Exception thrown when a rewrite rule replaced an element with a new element that does not comply with the contract of its parent container.

    Exception thrown when a rewrite rule replaced an element with a new element that does not comply with the contract of its parent container.

    The element property holds the offending element.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object RewriteException extends Serializable

    Permalink
  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[B](pf: PartialFunction[Element, B]): List[B]

    Permalink

    Collects elements by applying the partial function to all elements it is defined for, in depth-first traversal, including this element itself.

  8. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def foreach(f: (Element) ⇒ Unit): Unit

    Permalink

    Invokes the specified function for each child of this element container, including children of children, and this element itself, in depth-first traversal.

  12. final def getClass(): Class[_]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. def rewrite(rule: RewriteRule): Self

    Permalink

    Returns a new, rewritten tree model based on the specified rule.

    Returns a new, rewritten tree model based on the specified rule. The rule is a partial function that takes an Element and returns an Option[Element].

    If the function is not defined for a specific element the old element remains in the tree unchanged. If it returns None then the node gets removed from the tree, if it returns an element it will replace the old one. Of course the function may also return the old element.

    The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, therefore any element container passed to the rule only contains children which have already been processed.

    In case multiple rewrite rules need to be applied it may be more efficient to first combine them with orElse.

  19. def select(p: (Element) ⇒ Boolean): List[Element]

    Permalink

    Selects all elements satisfying the specified predicate, collecting in depth-first traversal, including this element itself.

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

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped