--- projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2000/11/23 09:36:07 1.2 +++ projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2000/12/07 23:26:16 1.6 @@ -1,25 +1,43 @@ +//---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; import uk.ac.ukc.iscream.core.*; -// 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.6 2000/12/07 23:26:16 tdb Exp $ + */ public class XMLPacketMaker extends HandlerBase { +//---FINAL ATTRIBUTES--- + + /** + * The current CVS revision of this class + */ + public final String REVISION = "$Revision: 1.6 $"; + +//---STATIC METHODS--- + +//---CONSTRUCTORS--- + // Constructor for accepting XML input. - public XMLPacketMaker (String xml, Logger logger) { - this.xml = xml; - this.logger = logger; + public XMLPacketMaker (String xml) { + _xml = xml; } +//---PUBLIC METHODS--- + public XMLPacket createXMLPacket() { // Create the XMLPacket to store values in. @@ -30,20 +48,39 @@ public class XMLPacketMaker extends HandlerBase { 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) { - logger.write(this.toString(), Logger.WARNING, "An invalid XML UDP packet has been detected: "+packet.printAll()); - //t.printStackTrace(); + _logger.write(this.toString(), Logger.WARNING, e.toString()); + _logger.write(this.toString(), Logger.WARNING, "An invalid XML UDP packet has been detected: "+packet.printAll()); return null; } return packet; } - - String xml; - Logger logger; -} \ No newline at end of file + + /** + * 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--- + +//---ACCESSOR/MUTATOR METHODS--- + +//---ATTRIBUTES--- + + String _xml; + Logger _logger = ReferenceManager.getInstance().getLogger(); + +//---STATIC ATTRIBUTES--- + +}