io.jbotsim.io.format.xml

Class XMLBuilder

java.lang.Object

io.jbotsim.io.format.xml.XMLBuilder

Direct Known Subclasses:

XMLTopologyBuilder, XMLTraceBuilder

public abstract class XMLBuilder
extends Object

Base class for ones used to build JBotSim XML document.

The class creates a XML document. Following jbotsim-DEFAULT_VERSION.xsd schema, a root element labelled "jbotsim" is added to the document and its attribute version is assigned the value DEFAULT_VERSION.

Helper methods exists to output the document using methods of the XMLIO class.

See Also:

XMLIO, XMLIO.XMLIOException

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLBuilder.BuilderException Exception raised whenever an error occurs while a Document is built.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION Default version of the XSD schema used to parse JBotsim XML documents.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLBuilder()

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Accessor to the Document handled by this builder.
String	writeToString() Outputs the current XML document into the specified file pointed by the given File descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final String DEFAULT_VERSION

Default version of the XSD schema used to parse JBotsim XML documents. Its current value is "1.0".

See Also:

Constant Field Values

Constructor Detail

XMLBuilder

protected XMLBuilder()
              throws XMLBuilder.BuilderException

Throws:

XMLBuilder.BuilderException

Method Detail

getDocument

public Document getDocument()

Accessor to the Document handled by this builder.

Returns:

the Document under construction

writeToString

public String writeToString()
                     throws XMLBuilder.BuilderException

Outputs the current XML document into the specified file pointed by the given File descriptor.

Returns:

the Document converted into a String.

Throws:

XMLBuilder.BuilderException - raised either when an XML error occurs while the document is created or if an IO error occurs.