org.xmlpull.v1.wrapper
Interface XmlSerializerWrapper

All Superinterfaces:

XmlSerializer

All Known Implementing Classes:

StaticXmlSerializerWrapper

public interface XmlSerializerWrapper
extends XmlSerializer

Extensions to XmlSerialzier interface

Field Summary

static java.lang.String	NO_NAMESPACE
static java.lang.String	XSD_NS
static java.lang.String	XSI_NS

Method Summary

XmlSerializerWrapper	attribute(java.lang.String name, java.lang.String value) Write an attribute without namespace.
XmlSerializerWrapper	element(java.lang.String elementName, java.lang.String elementText) Write simple text element in current namespace
XmlSerializerWrapper	element(java.lang.String namespace, java.lang.String elementName, java.lang.String elementText) Writes a simple element such as <username>johndoe</username>.
XmlSerializerWrapper	endTag(java.lang.String name) Write end tag in current namespace with name given as argument.
java.lang.String	escapeAttributeValue(java.lang.String text)
java.lang.String	escapeText(java.lang.String text)
void	event(XmlPullParser pp) Serializer current event form pull parser
void	fragment(java.lang.String xmlFragment) Write XML fragment using currently set namespace prefixes
java.lang.String	getCurrentNamespaceForElements() Get namespace that is used as default when no namespace parameter is used for startTag(), endTag() and element()
java.lang.String	setCurrentNamespaceForElements(java.lang.String value) Set namespace to use in startTag(), endTag() and element() when methods called are those without namespace parameter.
XmlSerializerWrapper	startTag(java.lang.String name) Write start tag in current namespace with name given as argument.

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, setPrefix, setProperty, startDocument, startTag, text, text

Field Detail

NO_NAMESPACE

static final java.lang.String NO_NAMESPACE

See Also:

Constant Field Values

XSI_NS

static final java.lang.String XSI_NS

See Also:

Constant Field Values

XSD_NS

static final java.lang.String XSD_NS

See Also:

Constant Field Values

Method Detail

getCurrentNamespaceForElements

java.lang.String getCurrentNamespaceForElements()

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

setCurrentNamespaceForElements

java.lang.String setCurrentNamespaceForElements(java.lang.String value)

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

attribute

XmlSerializerWrapper attribute(java.lang.String name,
                               java.lang.String value)
                               throws java.io.IOException,
                                      java.lang.IllegalArgumentException,
                                      java.lang.IllegalStateException

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.

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

startTag

XmlSerializerWrapper startTag(java.lang.String name)
                              throws java.io.IOException,
                                     java.lang.IllegalArgumentException,
                                     java.lang.IllegalStateException

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

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

endTag

XmlSerializerWrapper endTag(java.lang.String name)
                            throws java.io.IOException,
                                   java.lang.IllegalArgumentException,
                                   java.lang.IllegalStateException

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

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

element

XmlSerializerWrapper element(java.lang.String namespace,
                             java.lang.String elementName,
                             java.lang.String elementText)
                             throws java.io.IOException,
                                    XmlPullParserException

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.

Throws:

java.io.IOException

XmlPullParserException

element

XmlSerializerWrapper element(java.lang.String elementName,
                             java.lang.String elementText)
                             throws java.io.IOException,
                                    XmlPullParserException

Write simple text element in current namespace

Throws:

java.io.IOException

XmlPullParserException

fragment

void fragment(java.lang.String xmlFragment)
              throws java.io.IOException,
                     java.lang.IllegalArgumentException,
                     java.lang.IllegalStateException,
                     XmlPullParserException

Write XML fragment using currently set namespace prefixes

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

XmlPullParserException

event

void event(XmlPullParser pp)
           throws java.io.IOException,
                  java.lang.IllegalArgumentException,
                  java.lang.IllegalStateException,
                  XmlPullParserException

Serializer current event form pull parser

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

XmlPullParserException

escapeText

java.lang.String escapeText(java.lang.String text)
                            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

escapeAttributeValue

java.lang.String escapeAttributeValue(java.lang.String text)
                                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException