Package org.xmlpull.v1.wrapper.classic

Class StaticXmlSerializerWrapper

java.lang.Object

org.xmlpull.v1.wrapper.classic.XmlSerializerDelegate

org.xmlpull.v1.wrapper.classic.StaticXmlSerializerWrapper

All Implemented Interfaces:

XmlSerializerWrapper, XmlSerializer

public class StaticXmlSerializerWrapper
extends XmlSerializerDelegate
implements XmlSerializerWrapper

This class seemlesly extends exisiting serialzier implementation by adding new methods (provided by XmlPullUtil) and delegating exisiting methods to parser implementation.

Author:

Aleksander Slominski, Naresh Bhatia

Field Summary

Fields

Modifier and Type	Field	Description
protected String	currentNs
protected XmlPullParserWrapper	fragmentParser
protected int[]	namespaceDepth
protected int	namespaceEnd
protected String[]	namespacePrefix
protected String[]	namespaceUri
protected XmlPullWrapperFactory	wf

Fields inherited from class org.xmlpull.v1.wrapper.classic.XmlSerializerDelegate

xs

Fields inherited from interface org.xmlpull.v1.wrapper.XmlSerializerWrapper

NO_NAMESPACE, XSD_NS, XSI_NS

Constructor Summary

Constructors

Constructor	Description
StaticXmlSerializerWrapper(XmlSerializer xs, XmlPullWrapperFactory wf)

Method Summary

Modifier and Type	Method	Description
XmlSerializerWrapper	attribute(String name, String value)	Write an attribute without namespace.
XmlSerializerWrapper	element(String elementName, String elementText)	Write simple text element in current namespace
XmlSerializerWrapper	element(String namespace, String elementName, String elementText)	Writes a simple element such as <username>johndoe</username>.
XmlSerializerWrapper	endTag(String name)	Write end tag in current namespace with name given as argument.
String	escapeAttributeValue(String value)
String	escapeText(String text)
void	event(XmlPullParser pp)	Serializer current event form pull parser
void	fragment(String xmlFragment)	Write XML fragment using currently set namespace prefixes
String	getCurrentNamespaceForElements()	Get namespace that is used as default when no namespace parameter is used for startTag(), endTag() and element()
String	setCurrentNamespaceForElements(String value)	Set namespace to use in startTag(), endTag() and element() when methods called are those without namespace parameter.
void	setPrefix(String prefix, String namespace)	Binds the given prefix to the given namespace.
XmlSerializerWrapper	startTag(String name)	Write start tag in current namespace with name given as argument.
void	writeDouble(double d)
void	writeDoubleElement(String namespace, String name, double d)
void	writeFloat(float f)
void	writeFloatElement(String namespace, String name, float f)
void	writeInt(int i)
void	writeIntElement(String namespace, String name, int i)
void	writeString(String s)
void	writeStringElement(String namespace, String name, String s)

Methods inherited from class org.xmlpull.v1.wrapper.classic.XmlSerializerDelegate

attribute, cdsect, comment, docdecl, endDocument, endTag, entityRef, flush, getDepth, getFeature, getName, getNamespace, getPrefix, getProperty, ignorableWhitespace, processingInstruction, setFeature, setOutput, setOutput, setProperty, startDocument, startTag, text, text

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xmlpull.v1.XmlSerializer

attribute, cdsect, comment, docdecl, endDocument, endTag, entityRef, flush, getDepth, getFeature, getName, getNamespace, getPrefix, getProperty, ignorableWhitespace, processingInstruction, setFeature, setOutput, setOutput, setProperty, startDocument, startTag, text, text

Field Detail

currentNs

protected String currentNs

wf

protected XmlPullWrapperFactory wf

fragmentParser

protected XmlPullParserWrapper fragmentParser

namespaceEnd

protected int namespaceEnd

namespacePrefix

protected String[] namespacePrefix

namespaceUri

protected String[] namespaceUri

namespaceDepth

protected int[] namespaceDepth

Constructor Detail

StaticXmlSerializerWrapper

public StaticXmlSerializerWrapper(XmlSerializer xs,
                                  XmlPullWrapperFactory wf)

Method Detail

getCurrentNamespaceForElements

public String getCurrentNamespaceForElements()

Description copied from interface: XmlSerializerWrapper

Get namespace that is used as default when no namespace parameter is used for startTag(), endTag() and element()

Specified by:

getCurrentNamespaceForElements in interface XmlSerializerWrapper

setCurrentNamespaceForElements

public String setCurrentNamespaceForElements(String value)

Description copied from interface: XmlSerializerWrapper

Set namespace to use in startTag(), endTag() and element() when methods called are those without namespace parameter.

Specified by:

setCurrentNamespaceForElements in interface XmlSerializerWrapper

attribute

public XmlSerializerWrapper attribute(String name,
                                      String value)
                               throws IOException,
                                      IllegalArgumentException,
                                      IllegalStateException

Description copied from interface: XmlSerializerWrapper

Write an attribute without namespace. Calls to attribute() MUST follow a call to startTag() immediately. If there is no prefix defined for the given namespace, a prefix will be defined automatically. NOTE: current element namespace is not used attribute and attributre has no namespace.

Specified by:

attribute in interface XmlSerializerWrapper

Throws:

IOException

IllegalArgumentException

IllegalStateException

startTag

public XmlSerializerWrapper startTag(String name)
                              throws IOException,
                                     IllegalArgumentException,
                                     IllegalStateException

Description copied from interface: XmlSerializerWrapper

Write start tag in current namespace with name given as argument.

Specified by:

startTag in interface XmlSerializerWrapper

Throws:

IOException

IllegalArgumentException

IllegalStateException

endTag

public XmlSerializerWrapper endTag(String name)
                            throws IOException,
                                   IllegalArgumentException,
                                   IllegalStateException

Description copied from interface: XmlSerializerWrapper

Write end tag in current namespace with name given as argument.

Specified by:

endTag in interface XmlSerializerWrapper

Throws:

IOException

IllegalArgumentException

IllegalStateException

element

public XmlSerializerWrapper element(String elementName,
                                    String elementText)
                             throws IOException,
                                    XmlPullParserException

Write simple text element in current namespace

Specified by:

element in interface XmlSerializerWrapper

Throws:

IOException

XmlPullParserException

element

public XmlSerializerWrapper element(String namespace,
                                    String elementName,
                                    String elementText)
                             throws IOException,
                                    XmlPullParserException

Description copied from interface: XmlSerializerWrapper

Writes a simple element such as <username>johndoe</username>. The namespace and elementText are allowed to be null. If elementText is null, an xsi:nil="true" will be added as an attribute.

Specified by:

element in interface XmlSerializerWrapper

Throws:

IOException

XmlPullParserException

setPrefix

public void setPrefix(String prefix,
                      String namespace)
               throws IOException,
                      IllegalArgumentException,
                      IllegalStateException

Description copied from interface: XmlSerializer

Binds the given prefix to the given namespace. This call is valid for the next element including child elements. The prefix and namespace MUST be always declared even if prefix is not used in element (startTag() or attribute()) - for XML 1.0 it must result in declaring xmlns:prefix='namespace' (or xmlns:prefix="namespace" depending what character is used to quote attribute value).

NOTE: this method MUST be called directly before startTag() and if anything but startTag() or setPrefix() is called next there will be exception.

NOTE: prefixes "xml" and "xmlns" are already bound and can not be redefined see: Namespaces in XML Errata.

NOTE: to set default namespace use as prefix empty string.

Specified by:

setPrefix in interface XmlSerializer

Overrides:

setPrefix in class XmlSerializerDelegate

Parameters:

prefix - must be not null (or IllegalArgumentException is thrown)

namespace - must be not null

Throws:

IOException

IllegalArgumentException

IllegalStateException

fragment

public void fragment(String xmlFragment)
              throws IOException,
                     IllegalArgumentException,
                     IllegalStateException,
                     XmlPullParserException

Description copied from interface: XmlSerializerWrapper

Write XML fragment using currently set namespace prefixes

Specified by:

fragment in interface XmlSerializerWrapper

Throws:

IOException

IllegalArgumentException

IllegalStateException

XmlPullParserException

event

public void event(XmlPullParser pp)
           throws XmlPullParserException,
                  IOException

Description copied from interface: XmlSerializerWrapper

Serializer current event form pull parser

Specified by:

event in interface XmlSerializerWrapper

Throws:

XmlPullParserException

IOException

escapeAttributeValue

public String escapeAttributeValue(String value)

Specified by:

escapeAttributeValue in interface XmlSerializerWrapper

escapeText

public String escapeText(String text)

Specified by:

escapeText in interface XmlSerializerWrapper

writeDouble

public void writeDouble(double d)
                 throws XmlPullParserException,
                        IOException,
                        IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeFloat

public void writeFloat(float f)
                throws XmlPullParserException,
                       IOException,
                       IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeInt

public void writeInt(int i)
              throws XmlPullParserException,
                     IOException,
                     IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeString

public void writeString(String s)
                 throws XmlPullParserException,
                        IOException,
                        IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeDoubleElement

public void writeDoubleElement(String namespace,
                               String name,
                               double d)
                        throws XmlPullParserException,
                               IOException,
                               IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeFloatElement

public void writeFloatElement(String namespace,
                              String name,
                              float f)
                       throws XmlPullParserException,
                              IOException,
                              IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeIntElement

public void writeIntElement(String namespace,
                            String name,
                            int i)
                     throws XmlPullParserException,
                            IOException,
                            IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException

writeStringElement

public void writeStringElement(String namespace,
                               String name,
                               String s)
                        throws XmlPullParserException,
                               IOException,
                               IllegalArgumentException

Throws:

XmlPullParserException

IOException

IllegalArgumentException