java.lang.Object

org.tquadrat.foundation.xml.builder.internal.XMLDocumentImpl

All Implemented Interfaces:: Document<XMLElement>, XMLDocument

@ClassVersion(sourceVersion="$Id: XMLDocumentImpl.java 1071 2023-09-30 01:49:32Z tquadrat $") @API(status=INTERNAL, since="0.0.5") public final class XMLDocumentImpl extends Object implements XMLDocument

The implementation for the interface XMLDocument.

It allows document comments and processing instructions to be added.

Author:: Thomas Thrien (thomas.thrien@tquadrat.org)
Version:: $Id: XMLDocumentImpl.java 1071 2023-09-30 01:49:32Z tquadrat $
Since:: 0.0.5
UML Diagram: ⁠
UML Diagram for "org.tquadrat.foundation.xml.builder.internal.XMLDocumentImpl"
⁠

Field Summary

Fields

Modifier and Type

Field

Description

private final List<Element>

m_Children

The child elements for this document.

private final XMLElementImpl

m_RootElement

The root element for this document.
Constructor Summary

Constructors

Constructor

Description

XMLDocumentImpl()

Creates a new XMLDocumentImpl instance.

The resulting document will do not have an explicit doc type, the root element will be <root>.

XMLDocumentImpl(String rootElementName)

Creates a new XMLDocumentImpl instance.

The resulting document will do not have an explicit doc type, the encoding is defined as UTF-8.

The given root element name is validated using the method that is provided by XMLBuilderUtils.getElementNameValidator().

XMLDocumentImpl(String rootElementName, Charset encoding, String name, URI uri)

Creates a new XMLDocumentImpl instance.

The given root element name is validated using the method that is provided by XMLBuilderUtils.getElementNameValidator().

XMLDocumentImpl(String rootElementName, Charset encoding, URI uri)

Creates a new XMLDocumentImpl instance.

The given element name is validated using the method that is provided by XMLBuilderUtils.getElementNameValidator().

XMLDocumentImpl(XMLElement rootElement, boolean standalone)

Creates a new XMLDocumentImpl instance.

The resulting document will do not have an explicit doc type, the encoding is defined as UTF-8.

XMLDocumentImpl(XMLElement rootElement, Charset encoding, String name, URI uri)

Creates a new XMLDocumentImpl instance.

XMLDocumentImpl(XMLElement rootElement, Charset encoding, URI uri)

Creates a new XMLDocumentImpl instance.
Method Summary

Modifier and Type

Method

Description

final <E extends Element> XMLDocument

addDocumentChild(E child)

Adds a child to the document itself, not to the root element.

final XMLDocument

addDocumentComment(CharSequence comment)

Adds a comment to the document itself.

final XMLDocument

addProcessingInstruction(ProcessingInstruction processingInstruction)

Adds a processing instruction to this document.

final 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.

final XMLElement

getRootElement()

Return the root element for this document.

final void

registerAttributeSequence(String... attributes)

Registers an attribute sequence for the root element of this document; this modifies any sort order that was previously set.

The names for the attributes are not validated; in particular, it is not checked whether an attribute is listed as valid.

final void

registerAttributeSequence(Comparator<String> sortOrder)

Registers an attribute sequence for the root element of this document; this modifies any sort order that was previously set.

final void

registerValidAttributes(String... attributes)

Registers the valid attributes for the root element of this document.

final void

registerValidChildren(String... children)

Registers the element names of valid child elements for this document.

final String

toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Document
getAttribute, getAttributes, getElementName, getNamespaces, toString

Methods inherited from interface org.tquadrat.foundation.xml.builder.XMLDocument
addChild, addComment, addPredefinedMarkup, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeIfNotEmpty, setAttributeIfNotEmpty, setId, setNamespace, setNamespace, setNamespace, setNamespace, setNamespace

Field Details
- m_Children
  
  private final List<Element> m_Children
  
  The child elements for this document.
- m_RootElement
  
  private final XMLElementImpl m_RootElement
  
  The root element for this document.
Constructor Details
- XMLDocumentImpl
  
  public XMLDocumentImpl()
  Creates a new XMLDocumentImpl instance.
  
  The resulting document will do not have an explicit doc type, the root element will be <root>. The encoding is defined as UTF-8.
  
  Basically, this document would have the DTD
  <!ELEMENT root ANY>
  .
- XMLDocumentImpl
  
  public XMLDocumentImpl(String rootElementName)
  
  Creates a new XMLDocumentImpl instance.
  
  The resulting document will do not have an explicit doc type, the encoding is defined as UTF-8.
  
  The given root element name is validated using the method that is provided by XMLBuilderUtils.getElementNameValidator().
  
  Parameters:
  
  rootElementName - The name of the root element for this document.
- XMLDocumentImpl
  
  public XMLDocumentImpl(XMLElement rootElement, boolean standalone)
  
  Creates a new XMLDocumentImpl instance.
  
  The resulting document will do not have an explicit doc type, the encoding is defined as UTF-8.
  
  Parameters:
  
  rootElement - The root element for this document.
  
  standalone - true if the XML document is standalone, false if not.
- XMLDocumentImpl
  
  public XMLDocumentImpl(String rootElementName, Charset encoding, String name, URI uri)
  
  Creates a new XMLDocumentImpl instance.
  
  The given root element name is validated using the method that is provided by XMLBuilderUtils.getElementNameValidator().
  
  Parameters:
  
  rootElementName - The name for the root element for this document.
  
  encoding - The encoding for the new XML document.
  
  name - The name for the DTD.
  
  uri - The URI for the DTD.
- XMLDocumentImpl
  
  public XMLDocumentImpl(XMLElement rootElement, Charset encoding, String name, URI uri)
  
  Creates a new XMLDocumentImpl instance.
  
  Parameters:
  
  rootElement - The root element for this document.
  
  encoding - The encoding for the new XML document.
  
  name - The name for the DTD.
  
  uri - The URI for the DTD.
- XMLDocumentImpl
  
  public XMLDocumentImpl(String rootElementName, Charset encoding, URI uri)
  
  Creates a new XMLDocumentImpl instance.
  
  The given element name is validated using the method that is provided by XMLBuilderUtils.getElementNameValidator().
  
  Parameters:
  
  rootElementName - The name of the root element for this document.
  
  encoding - The encoding for the new XML document.
  
  uri - The URI for the DTD.
- XMLDocumentImpl
  
  public XMLDocumentImpl(XMLElement rootElement, Charset encoding, URI uri)
  
  Creates a new XMLDocumentImpl instance.
  
  Parameters:
  
  rootElement - The root element for this document.
  
  encoding - The encoding for the new XML document.
  
  uri - The URI for the DTD.
Method Details
- addDocumentChild
  
  public final <E extends Element> XMLDocument addDocumentChild(E child) throws IllegalStateException
  
  Adds a child to the document itself, not to the root element.
  
  Type Parameters:
  
  E - The type of the child to add.
  
  Parameters:
  
  child - The element to add.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalStateException - The child has already a parent that is not this document.
- addDocumentComment
  
  public final XMLDocument addDocumentComment(CharSequence comment) throws IllegalArgumentException
  
  Adds a comment to the document itself.
  
  Specified by:
  
  addDocumentComment in interface XMLDocument
  
  Parameters:
  
  comment - The comment to add.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - The document does not allow adding comments.
- addProcessingInstruction
  
  public final XMLDocument addProcessingInstruction(ProcessingInstruction processingInstruction) throws IllegalArgumentException, IllegalStateException
  
  Adds a processing instruction to this document.
  
  Specified by:
  
  addProcessingInstruction in interface XMLDocument
  
  Parameters:
  
  processingInstruction - The procession instruction to add.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - This document does not allow adding processing instructions.
  
  IllegalStateException - The processing instruction has already a parent.
- getChildren
  
  public final 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.
  
  Specified by:
  
  getChildren in interface Document<XMLElement>
  
  Returns:
  
  A reference to the children of this document.
- getRootElement
  
  public final XMLElement getRootElement()
  
  Return the root element for this document.
  
  Specified by:
  
  getRootElement in interface Document<XMLElement>
  
  Returns:
  
  The root element.
- registerAttributeSequence
  
  public final void registerAttributeSequence(String... attributes)
  
  Registers an attribute sequence for the root element of this document; this modifies any sort order that was previously set.
  
  The names for the attributes are not validated; in particular, it is not checked whether an attribute is listed as valid.
  
  Parameters:
  
  attributes - The names of the attributes in the desired sequence.
- registerAttributeSequence
  
  public final void registerAttributeSequence(Comparator<String> sortOrder)
  
  Registers an attribute sequence for the root element of this document; this modifies any sort order that was previously set.
  
  Parameters:
  
  sortOrder - The sort order for the attributes.
- registerValidAttributes
  
  public final void registerValidAttributes(String... attributes)
  
  Registers the valid attributes for the root element of this document.
  Note:
  
  The given attributes will be added to the already existing ones!
  
  Parameters:
  
  attributes - The names of the valid attributes.
  
  Throws:
  
  InvalidXMLNameException - One of the attribute names is invalid.
- registerValidChildren
  
  public final void registerValidChildren(String... children)
  
  Registers the element names of valid child elements for this document.
  Note:
  
  The given children will be added to the already existing ones!
  
  Parameters:
  
  children - The element names of the valid children.
- toString
  
  public final String toString()
  
  Overrides:
  
  toString in class Object

Class XMLDocumentImpl

UML Diagram for "org.tquadrat.foundation.xml.builder.internal.XMLDocumentImpl"

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Document

Methods inherited from interface org.tquadrat.foundation.xml.builder.XMLDocument

Field Details

m_Children

m_RootElement

Constructor Details

XMLDocumentImpl

XMLDocumentImpl

XMLDocumentImpl

XMLDocumentImpl

XMLDocumentImpl

XMLDocumentImpl

XMLDocumentImpl

Method Details

addDocumentChild

addDocumentComment

addProcessingInstruction

getChildren

getRootElement

registerAttributeSequence

registerAttributeSequence

registerValidAttributes

registerValidChildren

toString