Package org.testng.reporters

Class XMLStringBuffer

java.lang.Object
org.testng.reporters.XMLStringBuffer
public class XMLStringBuffer extends Object
This class allows you to generate an XML text document by pushing and popping tags from a stack maintained internally.

  • Field Details

    • EOL

      public static final String EOL
      End of line, value of 'line.separator' system property or '\n'

    • DEFAULT_INDENT_INCREMENT

      private static final String DEFAULT_INDENT_INCREMENT
      Tab space indent for XML document
      See Also:

    • m_buffer

      private IBuffer m_buffer
      The buffer to hold the xml document

    • m_tagStack

      private final Stack<Tag> m_tagStack
      The stack of tags to make sure XML document is well formed.

    • m_currentIndent

      private String m_currentIndent
      A string of space character representing the current indentation.

    • defaultComment

      private String defaultComment

    • INVALID_XML_CHARS

      private static final Pattern INVALID_XML_CHARS

  • Constructor Details

    • XMLStringBuffer

      public XMLStringBuffer()

    • XMLStringBuffer

      public XMLStringBuffer(String start)
      Parameters:
      start - A string of spaces indicating the indentation at which to start the generation. This constructor will not insert an <?xml prologue.

    • XMLStringBuffer

      public XMLStringBuffer(IBuffer buffer, String start)
      Parameters:
      buffer - The StringBuffer to use internally to represent the document.
      start - A string of spaces indicating the indentation at which to start the generation.

  • Method Details

    • init

      private void init(IBuffer buffer, String start)

    • init

      private void init(IBuffer buffer, String start, @Nullable String version, @Nullable String encoding)
      Parameters:
      start - A string of spaces indicating the indentation at which to start the generation.

    • setXmlDetails

      public void setXmlDetails(String v, String enc)
      Set the xml version and encoding for this document.
      Parameters:
      v - the XML version
      enc - the XML encoding

    • setDocType

      public void setDocType(String docType)
      Set the doctype for this document.
      Parameters:
      docType - The DOCTYPE string, without the "<!DOCTYPE " ">"

    • push

      public void push(String tagName, @Nullable String schema, @Nullable Properties attributes)
      Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
      Parameters:
      tagName - The name of the tag.
      schema - The schema to use (can be null or an empty string).
      attributes - A Properties file representing the attributes (or null)

    • push

      public void push(String tagName, @Nullable String schema)
      Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
      Parameters:
      tagName - The name of the tag.
      schema - The schema to use (can be null or an empty string).

    • push

      public void push(String tagName, @Nullable Properties attributes)
      Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
      Parameters:
      tagName - The name of the tag.
      attributes - A Properties file representing the attributes (or null)

    • push

      public void push(String tagName, String... attributes)

    • createProperties

      private Properties createProperties(String[] attributes)

    • push

      public void push(String tagName)
      Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
      Parameters:
      tagName - The name of the tag.

    • pop

      public void pop()
      Pop the last pushed element without verifying it if matches the previously pushed tag.

    • pop

      public void pop(String tagName)
      Pop the last pushed element and throws an AssertionError if it doesn't match the corresponding tag that was pushed earlier.
      Parameters:
      tagName - The name of the tag this pop() is supposed to match.

    • addRequired

      public void addRequired(String tagName, @Nullable String value)
      Add a required element to the current tag. An opening and closing tag will be generated even if value is null.
      Parameters:
      tagName - The name of the tag
      value - The value for this tag

    • addRequired

      public void addRequired(String tagName, @Nullable String value, @Nullable Properties attributes)
      Add a required element to the current tag. An opening and closing tag will be generated even if value is null.
      Parameters:
      tagName - The name of the tag
      value - The value for this tag
      attributes - A Properties file containing the attributes (or null)

    • addRequired

      public void addRequired(String tagName, @Nullable String value, String... attributes)

    • addOptional

      public void addOptional(String tagName, @Nullable String value, @Nullable Properties attributes)
      Add an optional String element to the current tag. If value is null, nothing is added.
      Parameters:
      tagName - The name of the tag
      value - The value for this tag
      attributes - A Properties file containing the attributes (or null)

    • addOptional

      public void addOptional(String tagName, @Nullable String value, String... attributes)

    • addOptional

      public void addOptional(String tagName, @Nullable String value)
      Add an optional String element to the current tag. If value is null, nothing is added.
      Parameters:
      tagName - The name of the tag
      value - The value for this tag

    • addOptional

      public void addOptional(String tagName, @Nullable Boolean value, @Nullable Properties attributes)
      Add an optional Boolean element to the current tag. If value is null, nothing is added.
      Parameters:
      tagName - The name of the tag
      value - The value for this tag
      attributes - A Properties file containing the attributes (or null)

    • addOptional

      public void addOptional(String tagName, @Nullable Boolean value)
      Add an optional Boolean element to the current tag. If value is null, nothing is added.
      Parameters:
      tagName - The name of the tag
      value - The value for this tag

    • addEmptyElement

      public void addEmptyElement(String tagName)
      Add an empty element tag (e.g. <foo/>)
      Parameters:
      tagName - The name of the tag

    • addEmptyElement

      public void addEmptyElement(String tagName, @Nullable Properties attributes)
      Add an empty element tag (e.g. >foo/<)
      Parameters:
      tagName - The name of the tag
      attributes - A Properties file containing the attributes (or null)

    • addEmptyElement

      public void addEmptyElement(String tagName, String... attributes)

    • addComment

      public void addComment(String comment)

    • addString

      public void addString(String s)

    • setDefaultComment

      public void setDefaultComment(String defaultComment)

    • addCDATA

      public void addCDATA(String content)

    • getStringBuffer

      public IBuffer getStringBuffer()
      Returns:
      The StringBuffer used to create the document.

    • toXML

      public String toXML()
      Returns:
      The String representation of the XML for this XMLStringBuffer.

    • getCurrentIndent

      public String getCurrentIndent()

    • toWriter

      public void toWriter(Writer fw)