io.jbotsim.io.format.xml

Class XMLIO

java.lang.Object

io.jbotsim.io.format.xml.XMLIO

public class XMLIO
extends Object

Helper class used for IO operations on JBotSim xml files. The read operations only ensure that the input files follow XML syntax; the validation of the document must be realized elsewhere.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLIO.XMLIOException Exception raised when an IO exception occurs or if the underlying XML reader yields an error.

Constructor Summary

Constructors

Constructor and Description
XMLIO(FileAsStream fileAsStream)

Method Summary

Modifier and Type	Method and Description
protected static Document	read(InputSource input) Reads an XML document from a SAX source.
protected static Document	read(InputStream input) Reads an XML document from an stream.
protected static Document	read(Reader input) Reads an XML document using a Reader.
Document	read(String filename) Reads an XML document from the file specified by filename.
static Document	readFromString(String input) Reads an XML document from a String.
void	write(String filename, Document document) Outputs the given document into the file filename.
static void	write(Writer out, Document doc) Outputs the given document using the given Writer.
static String	writeToString(Document doc) Outputs the given document into a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLIO

public XMLIO(FileAsStream fileAsStream)

Method Detail

write

public void write(String filename,
                  Document document)
           throws XMLIO.XMLIOException

Outputs the given document into the file filename.

Parameters:

filename - destination file

document - to be written in filename

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.

write

public static void write(Writer out,
                         Document doc)
                  throws XMLIO.XMLIOException

Outputs the given document using the given Writer.

Parameters:

out - the Writer object

doc - the document that has to be written using the Writer.

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.

writeToString

public static String writeToString(Document doc)
                            throws XMLIO.XMLIOException

Outputs the given document into a String.

Parameters:

doc - the document compiled into a String.

Returns:

the document docas a String.

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails.

read

public Document read(String filename)
              throws XMLIO.XMLIOException

Reads an XML document from the file specified by filename.

Parameters:

filename - the input file name.

Returns:

the XML document as a Document

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.

readFromString

public static Document readFromString(String input)
                               throws XMLIO.XMLIOException

Reads an XML document from a String.

Parameters:

input - the string that contains the text of the XML document

Returns:

the XML document as a Document

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.

read

protected static Document read(InputStream input)
                        throws XMLIO.XMLIOException

Reads an XML document from an stream.

Parameters:

input - the input stream

Returns:

the XML document as a Document

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.

read

protected static Document read(Reader input)
                        throws XMLIO.XMLIOException

Reads an XML document using a Reader.

Parameters:

input - the input Reader

Returns:

the XML document as a Document

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.

read

protected static Document read(InputSource input)
                        throws XMLIO.XMLIOException

Reads an XML document from a SAX source.

Parameters:

input - the input source

Returns:

the XML document as a Document

Throws:

XMLIO.XMLIOException - is thrown if an XML operation fails or if an IO exception occurs.