chargerlib

Class XMLGenerator

Object

chargerlib.XMLGenerator

public abstract class XMLGenerator
extends Object

Provides some general routines for generating XML, from which sub-classes may derive some benefit. Everything is assumed to be static in this generator.

Field Summary

Fields

Modifier and Type	Field and Description
static String	eol The result of System.getProperty( "line.separator" )
static String	tab Helpful in indentation; currently set to two spaces

Constructor Summary

Constructors

Constructor and Description
XMLGenerator()

Method Summary

Modifier and Type	Method and Description
static String	endTag(String tag) Returns a simple end tag of the form </tag>
static String	quoteForXML(String unquoted) Converts certain characters into their XML quoted versions; e.g., "<" becomes "&lt;".
static String	simpleTaggedString(String tag, String value) Rewrite its arguments for XML.
static String	simpleTaggedString(String tag, String value, String parameters) Rewrite its arguments for XML.
static String	startTag(String tag) Returns a simple tag.
static String	startTag(String tag, String parameters) Returns a simple tag with parameters, without any closing tag.
static String	tagWithParms(String tag, String parameters) Returns a tag with parameters, including a closing bracket.
static String	XMLHeader()

Methods inherited from class Object

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

Field Detail

eol

public static String eol

The result of System.getProperty( "line.separator" )

tab

public static String tab

Helpful in indentation; currently set to two spaces

Constructor Detail

XMLGenerator

public XMLGenerator()

Method Detail

XMLHeader

public static String XMLHeader()

Returns:

the string <?xml version=\"1.0\"?>

simpleTaggedString

public static String simpleTaggedString(String tag,
                                        String value,
                                        String parameters)

Rewrite its arguments for XML.

Parameters:

tag -

value - free text to be inserted between start and end tags.

parameters - a string of the form ... name1="value1" name2="value2" ...

Returns:

a string something like <tag name1="value1" name2="value2" > freetext </tag>

simpleTaggedString

public static String simpleTaggedString(String tag,
                                        String value)

Rewrite its arguments for XML.

Parameters:

tag -

value - free text to be inserted between start and end tags.

Returns:

a string something like <tag> freetext </tag>

startTag

public static String startTag(String tag)

Returns a simple tag.

Returns:

the string <tag>

startTag

public static String startTag(String tag,
                              String parameters)

Returns a simple tag with parameters, without any closing tag.

Returns:

a string something like <tag name1="value1" name2="value2">

tagWithParms

public static String tagWithParms(String tag,
                                  String parameters)

Returns a tag with parameters, including a closing bracket.

Returns:

a string something like <tag name1="value1" name2="value2"/>

endTag

public static String endTag(String tag)

Returns a simple end tag of the form </tag>

quoteForXML

public static String quoteForXML(String unquoted)

Converts certain characters into their XML quoted versions; e.g., "<" becomes "<". Currently the following are converted:

Character	Reference
&	&
<	&lt;
>	&gt;
"	&quot;
'	&apos;