eu.cdevreeze.yaidom.queryapi

IsNavigableApi

trait IsNavigableApi[E <: IsNavigableApi[E]] extends AnyRef

This trait offers Path-based navigation support.

This trait typically does not show up in application code using yaidom, yet its (uniform) API does. Hence, it makes sense to read the documentation of this trait, knowing that the API is offered by multiple element implementations.

This trait is purely abstract. The most common implementation of this trait is eu.cdevreeze.yaidom.queryapi.IsNavigable.

IsNavigableApi more formally

Some properties are expected to hold for "navigable elements":

getElemOrSelfByPath(Path.Root) == self

findElemOrSelfByPath(path1).flatMap(e => e.findElemOrSelfByPath(path2)) == findElemOrSelfByPath(path1.append(path2))
E

The captured element subtype

Self Type
E
Linear Supertypes
AnyRef, Any
Known Subclasses
DomElem, Elem, Elem, Elem, Elem, IsNavigable, ScalaXmlElem, UpdatableElemApi, UpdatableElemLike
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IsNavigableApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def findChildElemByPathEntry(entry: Entry): Option[E]

    Finds the child element with the given Path.Entry (where this element is the root), if any, wrapped in an Option.

  2. abstract def findElemOrSelfByPath(path: Path): Option[E]

    Finds the element with the given Path (where this element is the root), if any, wrapped in an Option.

    Finds the element with the given Path (where this element is the root), if any, wrapped in an Option.

    Note that for each non-empty Path, we have:

    findElemOrSelfByPath(path) == findChildElemByPathEntry(path.firstEntry) flatMap (e => e.findElemOrSelfByPath(path.withoutFirstEntry))

  3. abstract def getChildElemByPathEntry(entry: Entry): E

    Returns (the equivalent of) findChildElemByPathEntry(entry).get

  4. abstract def getElemOrSelfByPath(path: Path): E

    Returns (the equivalent of) findElemOrSelfByPath(path).get

Concrete Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  16. def toString(): String

    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped