Class

eu.cdevreeze.yaidom.indexed

IndexedDocument

Related Doc: package indexed

Permalink

abstract class IndexedDocument extends BackingDocumentApi with Immutable

Document, containing an "indexed" document element.

Note that class IndexedDocument does not have any query methods for Elem instances. In particular, the ElemApi does not apply to documents. Therefore, given a document, querying for elements (other than the document element itself) always goes via the document element.

Self Type
IndexedDocument
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IndexedDocument
  2. Immutable
  3. BackingDocumentApi
  4. DocumentApi
  5. AnyDocumentApi
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IndexedDocument(xmlDeclarationOption: Option[XmlDeclaration], children: IndexedSeq[CanBeDocumentChild])

    Permalink

Type Members

  1. type DocElemType = IndexedScopedNode.Elem[UnderlyingElem]

    Permalink

    The type of the document element.

    The type of the document element.

    Definition Classes
    IndexedDocumentBackingDocumentApiAnyDocumentApi
  2. abstract type ThisDoc <: IndexedDocument

    Permalink

    The document type itself.

    The document type itself. It must be restricted to a sub-type of the document API trait in question.

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

    Definition Classes
    IndexedDocumentDocumentApiAnyDocumentApi
  3. abstract type UnderlyingDoc <: Aux[UnderlyingDoc, UnderlyingElem]

    Permalink
  4. abstract type UnderlyingElem <: Aux[_, UnderlyingElem]

    Permalink

Abstract Value Members

  1. abstract def document: Aux[UnderlyingDoc, UnderlyingElem]

    Permalink
  2. abstract def withDocumentElement(newRoot: DocElemType): ThisDoc

    Permalink

    Creates a copy, but with the new documentElement passed as parameter newRoot

  3. abstract def withXmlDeclarationOption(newXmlDeclarationOption: Option[XmlDeclaration]): ThisDoc

    Permalink

    Creates a copy, but with the new xmlDeclarationOption passed as parameter newXmlDeclarationOption

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. val children: IndexedSeq[CanBeDocumentChild]

    Permalink

    Returns the child nodes of the document.

    Returns the child nodes of the document. Precisely one of them must be the document element.

    Definition Classes
    IndexedDocumentBackingDocumentApi
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def comments: IndexedSeq[Comment]

    Permalink

    Returns the comment child nodes of the document.

    Returns the comment child nodes of the document.

    Definition Classes
    IndexedDocumentBackingDocumentApi
  8. final def documentElement: DocElemType

    Permalink

    Returns the document element

    Returns the document element

    Definition Classes
    IndexedDocumentDocumentApi
  9. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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. final def processingInstructions: IndexedSeq[ProcessingInstruction]

    Permalink

    Returns the processing instruction child nodes of the document.

    Returns the processing instruction child nodes of the document.

    Definition Classes
    IndexedDocumentBackingDocumentApi
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. final def toString(): String

    Permalink
    Definition Classes
    IndexedDocument → AnyRef → Any
  21. final def uri: URI

    Permalink

    Returns the document URI, falling back to the empty URI if absent.

  22. final def uriOption: Option[URI]

    Permalink

    Returns the optional document URI, wrapped in an Option

    Returns the optional document URI, wrapped in an Option

    Definition Classes
    IndexedDocumentDocumentApi
  23. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. val xmlDeclarationOption: Option[XmlDeclaration]

    Permalink

    Returns the optional XML declaration.

    Returns the optional XML declaration.

    Definition Classes
    IndexedDocumentBackingDocumentApi

Inherited from Immutable

Inherited from BackingDocumentApi

Inherited from DocumentApi

Inherited from AnyDocumentApi

Inherited from AnyRef

Inherited from Any

Ungrouped