Package org.testng.reporters
Class XMLStringBuffer
java.lang.Object
org.testng.reporters.XMLStringBuffer
This class allows you to generate an XML text document by pushing and popping tags from a stack
maintained internally.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addComment
(String comment) void
addEmptyElement
(String tagName) Add an empty element tag (e.g.void
addEmptyElement
(String tagName, String... attributes) void
addEmptyElement
(String tagName, Properties attributes) Add an empty element tag (e.g.void
addOptional
(String tagName, Boolean value) Add an optional Boolean element to the current tag.void
addOptional
(String tagName, Boolean value, Properties attributes) Add an optional Boolean element to the current tag.void
addOptional
(String tagName, String value) Add an optional String element to the current tag.void
addOptional
(String tagName, String value, String... attributes) void
addOptional
(String tagName, String value, Properties attributes) Add an optional String element to the current tag.void
addRequired
(String tagName, String value) Add a required element to the current tag.void
addRequired
(String tagName, String value, String... attributes) void
addRequired
(String tagName, String value, Properties attributes) Add a required element to the current tag.void
void
pop()
Pop the last pushed element without verifying it if matches the previously pushed tag.void
Pop the last pushed element and throws an AssertionError if it doesn't match the corresponding tag that was pushed earlier.void
Push a new tag.void
Push a new tag.void
void
push
(String tagName, String schema, Properties attributes) Push a new tag.void
push
(String tagName, Properties attributes) Push a new tag.void
setDefaultComment
(String defaultComment) void
setDocType
(String docType) Set the doctype for this document.void
setXmlDetails
(String v, String enc) Set the xml version and encoding for this document.void
toXML()
-
Field Details
-
EOL
End of line, value of 'line.separator' system property or '\n'
-
-
Constructor Details
-
XMLStringBuffer
public XMLStringBuffer() -
XMLStringBuffer
- Parameters:
start
- A string of spaces indicating the indentation at which to start the generation. This constructor will not insert an<?xml
prologue.
-
XMLStringBuffer
- 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
-
setXmlDetails
Set the xml version and encoding for this document.- Parameters:
v
- the XML versionenc
- the XML encoding
-
setDocType
Set the doctype for this document.- Parameters:
docType
- The DOCTYPE string, without the "<!DOCTYPE " ">"
-
push
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
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
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
-
push
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
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
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 tagvalue
- The value for this tag
-
addRequired
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 tagvalue
- The value for this tagattributes
- A Properties file containing the attributes (or null)
-
addRequired
-
addOptional
Add an optional String element to the current tag. If value is null, nothing is added.- Parameters:
tagName
- The name of the tagvalue
- The value for this tagattributes
- A Properties file containing the attributes (or null)
-
addOptional
-
addOptional
Add an optional String element to the current tag. If value is null, nothing is added.- Parameters:
tagName
- The name of the tagvalue
- The value for this tag
-
addOptional
Add an optional Boolean element to the current tag. If value is null, nothing is added.- Parameters:
tagName
- The name of the tagvalue
- The value for this tagattributes
- A Properties file containing the attributes (or null)
-
addOptional
Add an optional Boolean element to the current tag. If value is null, nothing is added.- Parameters:
tagName
- The name of the tagvalue
- The value for this tag
-
addEmptyElement
Add an empty element tag (e.g.<foo/>
)- Parameters:
tagName
- The name of the tag
-
addEmptyElement
Add an empty element tag (e.g.>foo/<
)- Parameters:
tagName
- The name of the tagattributes
- A Properties file containing the attributes (or null)
-
addEmptyElement
-
addComment
-
addString
-
setDefaultComment
-
addCDATA
-
getStringBuffer
- Returns:
- The StringBuffer used to create the document.
-
toXML
- Returns:
- The String representation of the XML for this XMLStringBuffer.
-
getCurrentIndent
-
toWriter
-