--- projects/cms/source/util/uk/org/iscream/cms/util/XMLStringParser.java	2000/11/23 09:16:02	1.2
+++ projects/cms/source/util/uk/org/iscream/cms/util/XMLStringParser.java	2000/11/29 19:11:53	1.3
@@ -1,17 +1,34 @@
+//---PACKAGE DECLARATION---
+package uk.ac.ukc.iscream.xml;
+
+//---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
-
-// XMLStringParser - Used to assist in creating XMLPacket objects.
+/**
+ * XMLStringParser - Used to assist in creating XMLPacket objects.
+ *
+ * @author  $Author: tdb $
+ * @version $Id: XMLStringParser.java,v 1.3 2000/11/29 19:11:53 tdb Exp $
+ */
 public class XMLStringParser extends HandlerBase {
 
+//---FINAL ATTRIBUTES---
+
+    /**
+     * The current CVS revision of this class
+     */
+    public final String REVISION = "$Revision: 1.3 $";
+    
+//---STATIC METHODS---
+
+//---CONSTRUCTORS---
+
     // No-args constructor.  Generally not used.
     public XMLStringParser () {
         this.packet = new XMLPacket();
@@ -22,15 +39,13 @@ public class XMLStringParser extends HandlerBase {
         this.packet = packet;
     }
 
+//---PUBLIC METHODS---
+
     // Accessor to the XMLPacket.
     public XMLPacket getXMLPacket() {
         return packet;
     }
 
-    private int indentLevel = 0;
-    private ArrayList tagList = new ArrayList();
-    private XMLPacket packet;
-
     //===========================================================
     // SAX DocumentHandler methods
     //===========================================================
@@ -80,7 +95,18 @@ public class XMLStringParser extends HandlerBase {
         }
     }
 
+    /**
+     * Overrides the {@link java.lang.Object#toString() Object.toString()}
+     * method to provide clean logging (every class should have this).
+     *
+     * @return the name of this class and its CVS revision
+     */
+    public String toString() {
+        return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
+    }
 
+//---PRIVATE METHODS---
+
     //===========================================================
     // Helpers ...
     //===========================================================
@@ -97,5 +123,15 @@ public class XMLStringParser extends HandlerBase {
         }
         return path;
     }
-    
-}
\ No newline at end of file
+
+//---ACCESSOR/MUTATOR METHODS---
+
+//---ATTRIBUTES---
+
+    private int indentLevel = 0;
+    private ArrayList tagList = new ArrayList();
+    private XMLPacket packet;
+
+//---STATIC ATTRIBUTES---
+
+}