Class XmlBuilder

java.lang.Object
com.pnfsoftware.jeb.util.format.TextBuilder
com.pnfsoftware.jeb.util.format.XmlBuilder
All Implemented Interfaces:
Appendable

public class XmlBuilder extends TextBuilder
A specialized text builder used to craft XML documents sequentially.
  • Constructor Details

    • XmlBuilder

      public XmlBuilder()
      Create an XML builder with default indentation settings.
    • XmlBuilder

      public XmlBuilder(int indentationSize)
      Create an XML builder.
      Parameters:
      indentationSize - number of spaces per indentation level
    • XmlBuilder

      public XmlBuilder(int indentationSize, int initialCapacity)
      Create an XML builder.
      Parameters:
      indentationSize - number of spaces per indentation level
      initialCapacity - initial capacity of the underlying character buffer
  • Method Details

    • setAutoModifiers

      public void setAutoModifiers(int forNames, int forAttributeNames, int forAttributeValues, int forTextData)
      Set automatic modifiers for XML tokens.
      • 0 means leave as-is
      • 1 means escape
      • 2 means sanitize an unsafe token (that should be escaped already, but may not be, even if escaping is relevant.)
      By default, this object does not modify tokens, and prints them out as-is.
      Parameters:
      forNames - 0 (no-op) or 2 (sanitize)
      forAttributeNames - 0 (no-op) or 2 (sanitize)
      forAttributeValues - 0 (no-op), 1 (escape), or 2 (sanitize)
      forTextData - 0 (no-op), 1 (escape), or 2 (sanitize)
    • appendStandardHeader

      public void appendStandardHeader()
      Append a standard 1.0 header specifying a UTF-8 encoding and standalone=no.
    • appendHeader

      public void appendHeader(int versionMajor, int versionMinor, String encoding, boolean standalone)
      Append an XML header.
      Parameters:
      versionMajor - XML major version
      versionMinor - XML minor version
      encoding - declared character encoding
      standalone - true to mark the document as standalone
    • openElement

      public void openElement(String name)
      Output an XML element. The closing tag is not output.
      Parameters:
      name - the element name
    • openElement

      public void openElement(String name, Map<String,String> attributes)
      Output an XML element with attributes. The closing tag is not output.
      Parameters:
      name -
      attributes - optional attributes
    • openElement

      public void openElement(String name, Map<String,String> attributes, boolean close)
      Output an XML element with attributes.
      Parameters:
      name - the element name
      attributes - optional map of attributes name->value, which must be escaped (this method will append the attributes' names and values as-is)
      close - if true, the tag is immediately closed using "/>"
    • closeElement

      public void closeElement()
      Close the last opened element.
    • closeElement

      public void closeElement(boolean appendLine)
      Close the last opened element.
      Parameters:
      appendLine - if true, a new line is appended after the closing tag
    • appendText

      public void appendText(String s)
      Append text data, enclosed in tags.
      Parameters:
      s -
    • escapeAttributeValue

      public static String escapeAttributeValue(String s)
    • escapeTextValue

      public static String escapeTextValue(String s)
    • sanitizeElementName

      public static String sanitizeElementName(String name)
    • sanitizeAttributeName

      public static String sanitizeAttributeName(String name)
    • sanitizeAttributeValue

      public static String sanitizeAttributeValue(String s)
    • sanitizeTextValue

      public static String sanitizeTextValue(String s)
    • escapeAll

      public static CharSequence escapeAll(CharSequence s)
      Perform blanket escape of the input string: the character set (&, <, >, ", ') to their five predefined XML entities.
      Parameters:
      s - input string
      Returns:
      escaped string