--- projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2000/12/07 23:26:16 1.6 +++ projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2001/01/28 05:47:05 1.9 @@ -10,13 +10,11 @@ import javax.xml.parsers.SAXParserFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.SAXParser; -import uk.ac.ukc.iscream.core.*; - /** * XMLPacketMaker - Creates an XMLPacket object. * * @author $Author: tdb $ - * @version $Id: XMLPacketMaker.java,v 1.6 2000/12/07 23:26:16 tdb Exp $ + * @version $Id: XMLPacketMaker.java,v 1.9 2001/01/28 05:47:05 tdb Exp $ */ public class XMLPacketMaker extends HandlerBase { @@ -25,19 +23,29 @@ public class XMLPacketMaker extends HandlerBase { /** * The current CVS revision of this class */ - public final String REVISION = "$Revision: 1.6 $"; + public final String REVISION = "$Revision: 1.9 $"; //---STATIC METHODS--- //---CONSTRUCTORS--- - // Constructor for accepting XML input. + /** + * Constructor for accepting XML input. + * + * @param xml A String of XML to process. + */ public XMLPacketMaker (String xml) { _xml = xml; } //---PUBLIC METHODS--- + /** + * Method to create an XML packet from the data this + * class was constructed with. + * + * @return an XMLPacket representing the XML String given + */ public XMLPacket createXMLPacket() { // Create the XMLPacket to store values in. @@ -54,8 +62,6 @@ public class XMLPacketMaker extends HandlerBase { } catch (Exception e) { - _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; } @@ -66,10 +72,16 @@ public class XMLPacketMaker extends HandlerBase { * 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 this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")"; + return FormatName.getName( + _name, + getClass().getName(), + REVISION); } //---PRIVATE METHODS--- @@ -78,8 +90,21 @@ public class XMLPacketMaker extends HandlerBase { //---ATTRIBUTES--- + /** + * Holds the xml + */ String _xml; - Logger _logger = ReferenceManager.getInstance().getLogger(); + + /** + * 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---