Module org.tquadrat.foundation.xml
Package org.tquadrat.foundation.xml.builder.spi

Interface Document<E extends Element>

Type Parameters:
E - The implementation for the elements of this document.
All Known Subinterfaces:
XMLDocument
All Known Implementing Classes:
XMLDocumentImpl
@ClassVersion(sourceVersion="$Id: Document.java 980 2022-01-06 15:29:19Z tquadrat $") @API(status=MAINTAINED, since="0.0.5") public interface Document<E extends Element>
The definition for an SGML document.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: Document.java 980 2022-01-06 15:29:19Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.xml.builder.spi.Document"⁠

UML Diagram for "org.tquadrat.foundation.xml.builder.spi.Document"

UML Diagram for "org.tquadrat.foundation.xml.builder.spi.Document"⁠

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<String>
    getAttribute(String name)
    Returns the value for the attribute with the given name.

    The attribute is assigned to the root element of the document as documents itself cannot have attributes.
    default Map<String,String>
    getAttributes()
    Provides read access to the attributes of the root element of the document as documents itself cannot have attributes.
    default Collection<? extends Element>
    getChildren()
    Provides access to the children for this document; the returned collection is not modifiable.

    The root element is the last entry in the returned collection.
    default String
    getElementName()
    Returns the name of the root element.
    default Collection<Namespace>
    getNamespaces()
    Provides access to the namespaces for this document (although in fact, it will be the namespaces for the root element); the returned collection is not modifiable.
    E
    getRootElement()
    Return the root element for this document.
    default String
    toString(boolean prettyPrint)
    Returns a String representation for this element instance.

  • Method Details

    • getAttribute

      default Optional<String> getAttribute(String name)
      Returns the value for the attribute with the given name.

      The attribute is assigned to the root element of the document as documents itself cannot have attributes.
      Parameters:
      name - The attribute name.
      Returns:
      An instance of Optional that holds the value for that attribute.

    • getAttributes

      default Map<String,String> getAttributes()
      Provides read access to the attributes of the root element of the document as documents itself cannot have attributes.
      Returns:
      A reference to the attributes.

    • getChildren

      default Collection<? extends Element> getChildren()
      Provides access to the children for this document; the returned collection is not modifiable.

      The root element is the last entry in the returned collection.
      Returns:
      A reference to the children of this document.

    • getElementName

      default String getElementName()
      Returns the name of the root element.
      Returns:
      The name of the root element.

    • getNamespaces

      default Collection<Namespace> getNamespaces()
      Provides access to the namespaces for this document (although in fact, it will be the namespaces for the root element); the returned collection is not modifiable.
      Returns:
      A reference to the namespaces for the root element of this document; if it does not have namespaces assigned, an empty collection will be returned.
      See Also:

    • getRootElement

      E getRootElement()
      Return the root element for this document.
      Returns:
      The root element.

    • toString

      default String toString(boolean prettyPrint)
      Returns a String representation for this element instance.
      Parameters:
      prettyPrint - The pretty print flag.
      Returns:
      The String representation.