--- projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java	2000/11/22 08:40:53	1.1
+++ projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java	2001/03/01 16:55:11	1.10
@@ -1,50 +1,111 @@
+//---PACKAGE DECLARATION---
+package uk.ac.ukc.iscream.util;
+
+//---IMPORTS---
 import java.io.*;
 import java.util.ArrayList;
 
 import org.xml.sax.*;
-
 import javax.xml.parsers.SAXParserFactory;
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.parsers.SAXParser;
 
-// Paul Mutton, pjm2@ukc.ac.uk
-
-// XMLPacketMaker - Creates an XMLPacket object.
+/**
+ * XMLPacketMaker - Creates an XMLPacket object.
+ *
+ * @author  $Author: tdb $
+ * @version $Id: XMLPacketMaker.java,v 1.10 2001/03/01 16:55:11 tdb Exp $
+ */
 public class XMLPacketMaker extends HandlerBase {
 
-    // No-args constructor.  Generally not used.
-    public XMLPacketMaker () {
-        this.xml = "<packet></packet>";
-    }
+//---FINAL ATTRIBUTES---
 
-    // Constructor for accepting XML input.
+    /**
+     * The current CVS revision of this class
+     */
+    public final String REVISION = "$Revision: 1.10 $";
+    
+//---STATIC METHODS---
+
+//---CONSTRUCTORS---
+
+    /**
+     * Constructor for accepting XML input.
+     *
+     * @param xml A String of XML to process.
+     */
     public XMLPacketMaker (String xml) {
-        this.xml = xml;
+        _xml = xml;
     }
 
-    public XMLPacket createXMLPacket() {
+//---PUBLIC METHODS---
 
+    /**
+     * Method to create an XML packet from the data this
+     * class was constructed with.
+     *
+     * @return an XMLPacket representing the XML String given
+     * @throws InvalidXMLException if the XML cannot be parsed
+     */
+    public XMLPacket createXMLPacket() throws InvalidXMLException {
+
         // Create the XMLPacket to store values in.
         XMLPacket packet = new XMLPacket();
 
         // Use the default (non-validating) parser
         SAXParserFactory factory = SAXParserFactory.newInstance();
         try {
-
             // Parse the input
-            InputSource inputSource = new InputSource(new StringReader(xml));
+            InputSource inputSource = new InputSource(new StringReader(_xml));
             SAXParser saxParser = factory.newSAXParser();
             saxParser.parse(inputSource, new XMLStringParser(packet));
-
         }
         catch (Exception e) {
-            System.out.println("XMLPacketMaker - I just received an XML packet that did not contain valid XML.");
-            //t.printStackTrace();
-            return null;
+            // couldn't parse the XML for some reason
+            throw new InvalidXMLException("Could not parse the XML: "+_xml);
         }
-        
+        // parsed successfully, return the packet
         return packet;
     }
+
+    /**
+     * Overrides the {@link java.lang.Object#toString() Object.toString()}
+     * method to provide clean logging (every class should have this).
+     *
+     * This uses the uk.ac.ukc.iscream.util.NameFormat class
+     * to format the toString()
+     *
+     * @return the name of this class and its CVS revision
+     */
+    public String toString() {
+        return FormatName.getName(
+            _name,
+            getClass().getName(),
+            REVISION);
+    }
+
+//---PRIVATE METHODS---
+
+//---ACCESSOR/MUTATOR METHODS---
+
+//---ATTRIBUTES---
+
+    /**
+     * Holds the xml
+     */
+    String _xml;
     
-    String xml;
-}
\ No newline at end of file
+    /**
+     * This is the friendly identifier of the
+     * component this class is running in.
+     * eg, a Filter may be called "filter1",
+     * If this class does not have an owning
+     * component,  a name from the configuration
+     * can be placed here.  This name could also
+     * be changed to null for utility classes.
+     */
+    private String _name = null;
+
+//---STATIC ATTRIBUTES---
+
+}