Interface XmlSerializer
PLEASE NOTE: This interface will be part of XmlPull 1.2 API. It is included as basis for discussion. It may change in any way.
Exceptions that may be thrown are: IOException or runtime exception (more runtime exceptions can be thrown but are not declared and as such have no semantics defined for this interface):
- IllegalArgumentException - for almost all methods to signal that argument is illegal
- IllegalStateException - to signal that call has good arguments but is not expected here (violation of contract) and for features/properties when requesting setting unimplemented feature/property (UnsupportedOperationException would be better but it is not in MIDP)
NOTE: writing CDSECT, ENTITY_REF, IGNORABLE_WHITESPACE, PROCESSING_INSTRUCTION, COMMENT, and DOCDECL in some implementations may not be supported (for example when serializing to WBXML). In such case IllegalStateException will be thrown and it is recommened to use an optional feature to signal that implementation is not supporting this kind of output.
-
Method Summary
Modifier and TypeMethodDescriptionWrite an attribute.void
void
void
void
Finish writing.Write end tag.void
void
flush()
Write all pending output to the stream.int
getDepth()
Returns the current depth of the element.boolean
getFeature
(String name) Return the current value of the feature with given name.getName()
Returns the name of the current element as set by startTag().Returns the namespace URI of the current element as set by startTag().Return namespace that corresponds to given prefix If there is no prefix bound to this namespace return null but if generatePrefix is false then return generated prefix.getProperty
(String name) Look up the value of a property.void
ignorableWhitespace
(String text) void
processingInstruction
(String text) void
setFeature
(String name, boolean state) Set feature identified by name (recommended to be URI for uniqueness).void
setOutput
(OutputStream os, String encoding) Set to use binary output stream with given encoding.void
Set the output to the given writer.void
Binds the given prefix to the given namespace.void
setProperty
(String name, Object value) Set the value of a property.void
startDocument
(String encoding, Boolean standalone) Write <?xml declaration with encoding (if encoding not null) and standalone flag (if standalone not null) This method can only be called just after setOutput.Writes a start tag with the given namespace and name.text
(char[] buf, int start, int len) Writes text, where special XML chars are escaped automaticallyWrites text, where special XML chars are escaped automatically
-
Method Details
-
setFeature
Set feature identified by name (recommended to be URI for uniqueness). Some well known optional features are defined in http://www.xmlpull.org/v1/doc/features.html. If feature is not recocgnized or can not be set then IllegalStateException MUST be thrown.- Throws:
IllegalStateException
- If the feature is not supported or can not be setIllegalArgumentException
-
getFeature
Return the current value of the feature with given name.NOTE: unknown properties are always returned as null
- Parameters:
name
- The name of feature to be retrieved.- Returns:
- The value of named feature.
- Throws:
IllegalArgumentException
- if feature string is null
-
setProperty
Set the value of a property. (the property name is recommened to be URI for uniqueness). Some well known optional properties are defined in http://www.xmlpull.org/v1/doc/properties.html. If property is not recocgnized or can not be set then IllegalStateException MUST be thrown.- Throws:
IllegalStateException
- if the property is not supported or can not be setIllegalArgumentException
-
getProperty
Look up the value of a property. The property name is any fully-qualified URI. INOTE: unknown properties are
always returned as null - Parameters:
name
- The name of property to be retrieved.- Returns:
- The value of named property.
-
setOutput
void setOutput(OutputStream os, String encoding) throws IOException, IllegalArgumentException, IllegalStateException Set to use binary output stream with given encoding. -
setOutput
Set the output to the given writer.WARNING no information about encoding is available!
-
startDocument
void startDocument(String encoding, Boolean standalone) throws IOException, IllegalArgumentException, IllegalStateException Write <?xml declaration with encoding (if encoding not null) and standalone flag (if standalone not null) This method can only be called just after setOutput. -
endDocument
Finish writing. All unclosed start tags will be closed and output will be flushed. After calling this method no more output can be serialized until next call to setOutput() -
setPrefix
void setPrefix(String prefix, String namespace) throws IOException, IllegalArgumentException, IllegalStateException 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 declaringxmlns:prefix='namespace'
(orxmlns: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.
- Parameters:
prefix
- must be not null (or IllegalArgumentException is thrown)namespace
- must be not null- Throws:
IOException
IllegalArgumentException
IllegalStateException
-
getPrefix
Return namespace that corresponds to given prefix If there is no prefix bound to this namespace return null but if generatePrefix is false then return generated prefix.NOTE: if the prefix is empty string "" and defualt namespace is bound to this prefix then empty string ("") is returned.
NOTE: prefixes "xml" and "xmlns" are already bound will have values as defined Namespaces in XML specification
- Throws:
IllegalArgumentException
-
getDepth
int getDepth()Returns the current depth of the element. Outside the root element, the depth is 0. The depth is incremented by 1 when startTag() is called. The depth is decremented after the call to endTag() event was observed.<!-- outside --> 0 <root> 1 sometext 1 <foobar> 2 </foobar> 2 </root> 1 <!-- outside --> 0
-
getNamespace
String getNamespace()Returns the namespace URI of the current element as set by startTag().NOTE: that measn in particaulr that:
- if there was startTag("", ...) then getNamespace() returns ""
- if there was startTag(null, ...) then getNamespace() returns null
- Returns:
- namespace set by startTag() that is currently in scope
-
getName
String getName()Returns the name of the current element as set by startTag(). It can only be null before first call to startTag() or when last endTag() is called to close first startTag().- Returns:
- namespace set by startTag() that is currently in scope
-
startTag
XmlSerializer startTag(String namespace, String name) throws IOException, IllegalArgumentException, IllegalStateException Writes a start tag with the given namespace and name. If there is no prefix defined for the given namespace, a prefix will be defined automatically. The explicit prefixes for namespaces can be established by calling setPrefix() immediately before this method. If namespace is null no namespace prefix is printed but just name. If namespace is empty string then serialzier will make sure that default empty namespace is declared (in XML 1.0 xmlns='') or throw IllegalStateException if default namespace is already bound to non-empty string. -
attribute
XmlSerializer attribute(String namespace, String name, String value) throws IOException, IllegalArgumentException, IllegalStateException Write an attribute. 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. If namespace is null or empty string no namespace prefix is printed but just name. -
endTag
XmlSerializer endTag(String namespace, String name) throws IOException, IllegalArgumentException, IllegalStateException Write end tag. Repetition of namespace and name is just for avoiding errors.Background: in kXML endTag had no arguments, and non matching tags were very difficult to find... If namespace is null no namespace prefix is printed but just name. If namespace is empty string then serialzier will make sure that default empty namespace is declared (in XML 1.0 xmlns='').
-
text
Writes text, where special XML chars are escaped automatically -
text
XmlSerializer text(char[] buf, int start, int len) throws IOException, IllegalArgumentException, IllegalStateException Writes text, where special XML chars are escaped automatically -
cdsect
-
entityRef
-
processingInstruction
void processingInstruction(String text) throws IOException, IllegalArgumentException, IllegalStateException -
comment
-
docdecl
-
ignorableWhitespace
void ignorableWhitespace(String text) throws IOException, IllegalArgumentException, IllegalStateException -
flush
Write all pending output to the stream. If method startTag() or attribute() was called then start tag is closed (final >) before flush() is called on underlying output stream.NOTE: if there is need to close start tag (so no more attribute() calls are allowed) but without flushinging output call method text() with empty string (text("")).
- Throws:
IOException
-