Trait

eu.cdevreeze.yaidom.queryapi

AnyElemApi

Related Doc: package queryapi

Permalink

trait AnyElemApi extends AnyRef

Super-trait for all element query API traits, promising a self type.

Simplicity and consistency of the entire query API are 2 important design considerations. For example, the query API methods themselves use no generics.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AnyElemApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. abstract type ThisElem <: ThisElemApi

    Permalink

    The ("stable") element type itself.

    The ("stable") element type itself. It is not restricted in the query API traits (only indirectly, through ThisElemApi).

    Concrete element classes will restrict this type to that element class itself.

  2. abstract type ThisElemApi <: AnyElemApi

    Permalink

    Upperbound on type ThisElem, which must be restricted to a sub-type of the query API trait in question.

    Upperbound on type ThisElem, which must be restricted to a sub-type of the query API trait in question.

    Concrete element classes will restrict this type to that element class itself.

    The purely abstract query API traits (XXXApi) should only restrict this type to a sub-type of the query API trait, without putting any further restrictions on the type. This way these purely abstract traits are easy to use as "generic" element contracts abstracting over multiple backing element implementations (for example, Saxon tiny trees and native yaidom elements) without "infecting" the client code with generics.

    To a lesser extent, this should also be true for the partially implemented query API traits (XXXLike).

Abstract Value Members

  1. abstract def thisElem: ThisElem

    Permalink

    This element itself.

Concrete 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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def downcast[A <: AnyElemApi](implicit clsTag: ClassTag[A]): A

    Permalink

    Downcasts this element to a sub-type of AnyElemApi.

    Downcasts this element to a sub-type of AnyElemApi. It is needed in generic code written against "raw" query API traits.

    A safe usage pattern is as follows: choose a query API trait to start with, such as BackingElemApi. Whenever needed while querying, downcast the result(s) to that same type. This should be safe while using query methods of that query API trait or one of the super-type traits.

    Hence, the convenience of programming against "raw" query API traits is traded for some (relatively safe) casting inconvenience.

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped