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

Class ProcessingInstructionImpl

java.lang.Object
org.tquadrat.foundation.xml.builder.internal.ProcessingInstructionImpl
All Implemented Interfaces:
ProcessingInstruction, Element
@ClassVersion(sourceVersion="$Id: ProcessingInstructionImpl.java 1101 2024-02-18 00:18:48Z tquadrat $") @API(status=INTERNAL, since="0.0.5") public final class ProcessingInstructionImpl extends Object implements ProcessingInstruction
The implementation for the interface ProcessingInstruction.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: ProcessingInstructionImpl.java 1101 2024-02-18 00:18:48Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.xml.builder.internal.ProcessingInstructionImpl"⁠

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

UML Diagram for "org.tquadrat.foundation.xml.builder.internal.ProcessingInstructionImpl"⁠

  • Field Details

  • Constructor Details

    • ProcessingInstructionImpl

      public ProcessingInstructionImpl(String name)
      Creates a new ProcessingInstruction instance.
      Parameters:
      name - The name for this processing instruction.

    • ProcessingInstructionImpl

      public ProcessingInstructionImpl()
      Creates the ProcessingInstruction instance for the XML header.

    • ProcessingInstructionImpl

      public ProcessingInstructionImpl(String name, CharSequence data)
      Creates a new ProcessingInstruction instance.
      Parameters:
      name - The name for this processing instruction.
      data - The data for the processing instruction; can be null.

  • Method Details

    • addData

      public final ProcessingInstruction addData(CharSequence data)
      Adds data to the processing instruction.
      Specified by:
      addData in interface ProcessingInstruction
      Parameters:
      data - The data to add.
      Returns:
      This instance.

    • getAttribute

      public final Optional<String> getAttribute(String name)
      Returns the value for the attribute with the given name.
      Specified by:
      getAttribute in interface Element
      Parameters:
      name - The attribute name.
      Returns:
      An instance of Optional that holds the value for that attribute.

    • getAttributes

      public final Map<String,String> getAttributes()
      Provides read access to the attributes.
      Specified by:
      getAttributes in interface Element
      Returns:
      A reference to the attributes.

    • getChildren

      public final Collection<? extends Element> getChildren()
      Provides access to the children for this element; the returned collection is not modifiable.
      Specified by:
      getChildren in interface Element
      Returns:
      A reference to the children of this element; if the element does not have children, an empty collection will be returned.

    • getElementName

      public final String getElementName()
      Returns the name of the element.
      Specified by:
      getElementName in interface Element
      Returns:
      The name of the element.

    • getNamespaces

      public final Collection<Namespace> getNamespaces()
      Provides access to the namespaces for this element; the returned collection is not modifiable.
      Specified by:
      getNamespaces in interface Element
      Returns:
      A reference to the namespaces of this element; if the element does not have namespaces assigned, an empty collection will be returned.

    • getParent

      public final Optional<Element> getParent()
      Returns the parent of this element.
      Specified by:
      getParent in interface Element
      Returns:
      An instance of Optional that holds the parent.

    • hasChildren

      public final boolean hasChildren()
      Returns true if the element has children, false otherwise.
      Specified by:
      hasChildren in interface Element
      Returns:
      true if the element has children.

    • isBlock

      public final boolean isBlock()
      Returns the block flag.

      This flag is used in the conversion of the element into a String; it indicates whether the element is 'inline' (like an HTML <span>) or 'block' (as an HTML <div>). This is important only for elements where whitespace is relevant, like for HTML elements, as pretty printing will add additional whitespace around inline elements that can become visible on parsing (for HTML: on the rendered page).

      XML elements for example will be always block as there whitespace is not that important.

      Obviously, true indicates a block element, while false stands for an inline element.

      The default is true.
      Specified by:
      isBlock in interface Element
      Returns:
      The flag.

    • setAttribute

      public final ProcessingInstruction setAttribute(String name, CharSequence value, Optional<? extends CharSequence> append) throws IllegalArgumentException

      Sets the attribute with the given name.

      The given attribute name is validated using the method that is provided by XMLBuilderUtils.getAttributeNameValidator().

      Specified by:
      setAttribute in interface ProcessingInstruction
      Parameters:
      name - The name of the attribute; the name is case-sensitive.
      value - The attribute's value; if null the attribute will be removed.
      append - If not empty, the new value will be appended on an already existing one, and this sequence is used as the separator.
      Returns:
      This instance.
      Throws:
      IllegalArgumentException - An attribute with the given name is not valid for the element.

    • setParent

      public final <E extends Element> void setParent(E parent)
      Sets the parent for this element.
      Specified by:
      setParent in interface Element
      Type Parameters:
      E - The implementation of Element.
      Parameters:
      parent - The parent.

    • toString

      public final String toString(int indentationLevel, boolean prettyPrint)
      Returns a String representation for this element instance.
      Specified by:
      toString in interface Element
      Parameters:
      indentationLevel - The indentation level.
      prettyPrint - The pretty print flag.
      Returns:
      The String representation.

    • toString

      public final String toString()
      Overrides:
      toString in class Object