org.nees.rbnb.Xml Class Reference

List of all members.

Static Public Member Functions
Document	createDocument ()
	Create a new DOM Document.
Document	readDocument (String name)
	Read a DOM Document from xml in a file.
Document	readDocumentFromString (String in)
	Read a DOM Document from xml in a string.
void	writeDocument (Document doc, String fileName) throws IOException
	Write a DOM Document to an xml file.
String	writeDocumentToString (Document doc) throws IOException
	Write a DOM Document to an output stream.
String	errorXml (String problem, String reason)
String	statusXml (String string)
Static Public Attributes
final String	XML_TAG_FOR_ERROR_MESSAGE = "errorMessage"
final String	XML_TAG_FOR_STATUS_MESSAGE = "statusMessage"

---

Detailed Description

Xml is a DOM XML helper object adapted from the object of the same name in CHEF. It has been extended as a utility class for the RBNB NEES Project.

Author:

The Chef team

Glenn Golden

Terry E Weymouth

Version:

CVS Revision number

Revision

1.4

Definition at line 24 of file Xml.java.

---

Member Function Documentation

Document org.nees.rbnb.Xml.createDocument (   )  [static]

Create a new DOM Document. Returns: A new DOM document. Definition at line 34 of file Xml.java.

Document org.nees.rbnb.Xml.readDocument (  String  name  )  [static]

Read a DOM Document from xml in a file. Parameters: name  The file name for the xml file. Returns: A new DOM Document with the xml contents. Definition at line 56 of file Xml.java. References org.nees.rbnb.Xml.readDocument(). Referenced by org.nees.rbnb.Xml.readDocument().

Document org.nees.rbnb.Xml.readDocumentFromString (  String  in  )  [static]

Read a DOM Document from xml in a string. Parameters: in  The string containing the XML Returns: A new DOM Document with the xml contents. Definition at line 80 of file Xml.java. References org.nees.rbnb.Xml.readDocumentFromString(). Referenced by org.nees.rbnb.Xml.readDocumentFromString().

String org.nees.rbnb.Xml.statusXml (  String  string  )  [static]

Parameters: string  Returns: Definition at line 150 of file Xml.java. References org.nees.rbnb.Xml.statusXml(). Referenced by org.nees.rbnb.Xml.statusXml().

void org.nees.rbnb.Xml.writeDocument (  Document  doc, String  fileName )  throws IOException [static]

Write a DOM Document to an xml file. Parameters: doc  The DOM Document to write. fileName  The complete file name path. Definition at line 102 of file Xml.java. References org.nees.rbnb.Xml.writeDocument(). Referenced by org.nees.rbnb.Xml.writeDocument().

String org.nees.rbnb.Xml.writeDocumentToString (  Document  doc  )  throws IOException [static]

Write a DOM Document to an output stream. Parameters: doc  The DOM Document to write. out  The output stream. Definition at line 119 of file Xml.java. References org.nees.rbnb.Xml.writeDocumentToString(). Referenced by org.nees.rbnb.Xml.writeDocumentToString().

---

The documentation for this class was generated from the following file:

• Xml.java

---