io.jbotsim.io.format.xml

Class XMLTopologyBuilder

java.lang.Object

io.jbotsim.io.format.xml.XMLBuilder

io.jbotsim.io.format.xml.XMLTopologyBuilder

public class XMLTopologyBuilder
extends XMLBuilder

Builder for topologies objects.

This class is used, mainly, through methods inherited from XMLBuilder. The class method buildTopologyElement(org.w3c.dom.Document, io.jbotsim.core.Topology) can be invoked to build the element that stores an entire Topology.

Nested Class Summary

Nested classes/interfaces inherited from class io.jbotsim.io.format.xml.XMLBuilder

XMLBuilder.BuilderException

Field Summary

Fields inherited from class io.jbotsim.io.format.xml.XMLBuilder

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
XMLTopologyBuilder(Topology tp) This constructor add to the root element of the document the topology element that stores the topology.

Method Summary

Modifier and Type	Method and Description
static Element	buildTopologyElement(Document doc, Topology tp) Method that builds the actual element (and subtrees) that stores the givent Topology tp.

Methods inherited from class io.jbotsim.io.format.xml.XMLBuilder

getDocument, writeToString

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLTopologyBuilder

public XMLTopologyBuilder(Topology tp)
                   throws XMLBuilder.BuilderException

This constructor add to the root element of the document the topology element that stores the topology.

Parameters:

tp - the Topology for which the Document is built.

Throws:

BuilderException - is raised if an error occurs during the construction of the document.

XMLBuilder.BuilderException

Method Detail

buildTopologyElement

public static Element buildTopologyElement(Document doc,
                                           Topology tp)

Method that builds the actual element (and subtrees) that stores the givent Topology tp. Note that this method does not add the generated element to the XML document. This task is devoted to client methods.

Parameters:

doc - the document for which elements are created.

tp - the topology to be translated in XML.

Returns:

the element represetning the Topology tp