toString is a serializer for the data contained in the
* object to an equivalent snippet of XML stream.
*
* @return a String value which contains the XML
* representation of this object
*/
public String toString()
{
StringBuffer retval=new StringBuffer();
appendToXML(retval);
return new String(retval);
}
/**
* appendToXML appends the XML representation of the
* current packet data to the specified StringBuffer.
*
* @param xml The StringBuffer to append to
*/
public abstract void appendToXML(StringBuffer xml);
/**
* appendElement adds the XML for a child 'element' to a
* StringBuffer, as a helper to appendItem.
*
* @param xml a StringBuffer value
* @param name a String value
* @param value a String value
*
* @return a bool which is true if the element was generated.
* This is used for any shortcuts in the outputted XML
*/
protected static final boolean appendElement(StringBuffer xml,String name,String value)
{
if (value==null) return false;
xml.append( '<' );
xml.append(name);
if(value.equals(""))
{//shortcut
xml.append("/>" );
return true;
}
xml.append( '>' );
escapeString(xml, value);
xml.append( "' );
return true;
}
/**
* appendElement adds the XML for a child 'element' to a
* StringBuffer, as a helper to appendItem.
*
* @param xml a StringBuffer value
* @param name a String value
* @param value a String value
*
* @return a bool which is true if the element was generated.
* This is used for any shortcuts in the outputted XML
*/
protected static final boolean appendElement(StringBuffer xml,String name,Object value)
{
if (value==null) return false;
return appendElement(xml,name,value.toString());
}
/**
* appendElement outputs an element if needed. If value=false
* it does not output the tag.
*
* @param xml a StringBuffer value
* @param name a String value
* @param value a boolean value
*
* @return a bool which is true if the element was generated.
* This is used for any shortcuts in the outputted XML
*/
protected static final boolean appendElement(StringBuffer xml,String name,boolean value)
{
if (value==false)return false;
xml.append( '<' );
xml.append(name);
xml.append( "/>" );
return true;
}
/**
* appendElement adds a the entry's of a map to the stingbuffer
*
* @param xml a StringBuffer value
* @param map a Map value
*
* @return a bool which is true if the element was generated.
* This is used for any shortcuts in the outputted XML
*/
protected static final boolean appendElement(StringBuffer xml,Map map)
{
if (map == null) return false;
for (Iterator i=map.entrySet().iterator(); i.hasNext(); )
{
Map.Entry e = (Map.Entry) i.next();
String name = (String)e.getKey();
String value =(String)e.getValue();
if (value==null) continue;
xml.append( '<' );
xml.append(name);
if(value.equals(""))
{//shortcut
xml.append("/>" );
continue;
}
xml.append( '>' );
escapeString(xml, value);
xml.append( "' );
}
return false;
}
/**
* appendAttribute outputs an attribute if needed. If value=null
* it will not output the attribute. Note that it outputs in the format:
* &qout; attrib=value&qout;, or it puts a proceeding
* space in front of the attribute, and no trailing space. This is for
* optimizing the XML generation.
*
* @param xml a StringBuffer value
* @param name a String value
* @param value a boolean value
*
* @return a bool which is true if the attribute was
* generated. This is used for any shortcuts in the outputted XML
*/
protected static final boolean appendAttribute(StringBuffer xml,String name,String value)
{
if (value==null || value.length()<1) return false;
xml.append( ' ' );
xml.append(name );
xml.append("=\"");
escapeString(xml,value);
xml.append("\"");
return true;
}
/**
* appendAttribute outputs an attribute if needed. If value=null
* it will not output the attribute. Note that it outputs in the format:
* &qout; attrib=value&qout;, or it puts a proceeding
* space in front of the attribute, and no trailing space. This is for
* optimizing the XML generation.
*
* @param xml a StringBuffer value
* @param name a String value
* @param value a Object value, which supports toString()
*
* @return a bool which is true if the attribute was
* generated. This is used for any shortcuts in the outputted XML
*/
protected static final boolean appendAttribute(StringBuffer xml,String name,Object value)
{
if (value==null) return false;
return appendAttribute(xml,name,value.toString());
}
public static final void escapeString(StringBuffer xml, String data)
{
char c;
for (int i=0;i