org.xmlactions.common.xml

Class XMLBuilder

java.lang.Object

org.xmlactions.common.xml.XMLBuilder

public class XMLBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
XMLBuilder(boolean wantHeader) Create an instance of XMLBuilder

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.lang.String value) Adds an attribute to an open element.
void	addClosedElement(java.lang.String elementName) Adds a closed element.
void	addContent(java.lang.String content) Adds the content to the xml.
void	addContentWithCDATA(java.lang.String content) Adds the content to the xml surrounding it with the CDATA construct.
void	addElementAndContent(java.lang.String elementName, java.lang.String content) Adds a new element with this content and closes the element.
void	addLineFeed() Adds a line feed to the xml
void	addOpenElement(java.lang.String elementName) Adds a new element leaving the end open so you can add attributes.
void	append(char c) Appends a char to the xml.
void	append(java.lang.String s) Appends a String to the xml.
void	append(java.lang.StringBuffer sb) Appends a StringBuffer to the xml.
XMLBuilder	buildCPUTime(java.lang.String identifier, long startTime, long endTime) Adds the cpu time to the xml
void	closeElement() Closes and element by appending '/>'
void	closeElement(java.lang.String elementName) Closes and element by appending '</elementName>'
void	closeOpenElement() Closes an open element by appending '>'
void	endElement() Closes and element by appending '/>'
byte[]	getBytes() Returns the xml as a byte array
void	indent(int spaces) Adds a number of spaces to the xml
java.lang.String	toString() Returns the xml as a string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLBuilder

public XMLBuilder(boolean wantHeader)

Create an instance of XMLBuilder

Parameters:

wantHeader - if set true includes <?xml version="1.0"?>

Method Detail

addOpenElement

public void addOpenElement(java.lang.String elementName)

Adds a new element leaving the end open so you can add attributes. Looks like '<elementName '

Parameters:

elementName - is the name of the element.

addClosedElement

public void addClosedElement(java.lang.String elementName)

Adds a closed element. Looks like '<elementName>'

Parameters:

elementName - is the name of the element.

addElementAndContent

public void addElementAndContent(java.lang.String elementName,
                                 java.lang.String content)

Adds a new element with this content and closes the element. Looks like '<elementName>content</elementName>

Parameters:

elementName - is the element name

content - is the element content.

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

Adds an attribute to an open element. Looks like 'name="value"'

Parameters:

name - is the attribute name

value - is the value for the attribute.

endElement

public void endElement()

Closes and element by appending '/>'

closeOpenElement

public void closeOpenElement()

Closes an open element by appending '>'

closeElement

public void closeElement()

Closes and element by appending '/>'

closeElement

public void closeElement(java.lang.String elementName)

Closes and element by appending '</elementName>'

Parameters:

elementName - is the close element name.

append

public void append(char c)

Appends a char to the xml.

Parameters:

c - is the char to append.

append

public void append(java.lang.String s)

Appends a String to the xml.

Parameters:

s - is the String to append.

append

public void append(java.lang.StringBuffer sb)

Appends a StringBuffer to the xml.

Parameters:

sb - is the StringBuffer to append.

addContent

public void addContent(java.lang.String content)

Adds the content to the xml.

Parameters:

content - is the content to append.

addContentWithCDATA

public void addContentWithCDATA(java.lang.String content)

Adds the content to the xml surrounding it with the CDATA construct.

Parameters:

content - is the content to append.

getBytes

public byte[] getBytes()

Returns the xml as a byte array

Returns:

the xml as a byte array.

toString

public java.lang.String toString()

Returns the xml as a string

Overrides:

toString in class java.lang.Object

Returns:

the xml as a string.

addLineFeed

public void addLineFeed()

Adds a line feed to the xml

indent

public void indent(int spaces)

Adds a number of spaces to the xml

Parameters:

spaces - is the number of spaces to add.

buildCPUTime

public XMLBuilder buildCPUTime(java.lang.String identifier,
                               long startTime,
                               long endTime)

Adds the cpu time to the xml

Parameters:

identifier - is an attribute 'identifier' to add

startTime - is the StartTime in milliseconds attribute

endTime - is the endTime in milliseconds attribute value Looks like '<CPUTime identifier="identifier" format="milliseconds" startTime="startTime" endTime="endTime" totalTime="hh:mm:ss:ii"/>