FEATURE_NAMES_INTERNED
protected final String FEATURE_NAMES_INTERNED
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected final String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
PROPERTY_LOCATION
protected static final String PROPERTY_LOCATION
PROPERTY_SERIALIZER_INDENTATION
protected final String PROPERTY_SERIALIZER_INDENTATION
PROPERTY_SERIALIZER_LINE_SEPARATOR
protected final String PROPERTY_SERIALIZER_LINE_SEPARATOR
XMLNS_URI
protected static final String XMLNS_URI
XML_URI
protected static final String XML_URI
attributeUseApostrophe
protected boolean attributeUseApostrophe
autoDeclaredPrefixes
protected int autoDeclaredPrefixes
doIndent
protected boolean doIndent
elName
protected String[] elName
elNamespace
protected String[] elNamespace
elNamespaceCount
protected int[] elNamespaceCount
finished
protected boolean finished
indentationBuf
protected char[] indentationBuf
indentationJump
protected int indentationJump
indentationString
protected String indentationString
lineSeparator
protected String lineSeparator
location
protected String location
maxIndentLevel
protected int maxIndentLevel
namesInterned
protected boolean namesInterned
namespaceEnd
protected int namespaceEnd
namespacePrefix
protected String[] namespacePrefix
namespaceUri
protected String[] namespaceUri
offsetNewLine
protected int offsetNewLine
pastRoot
protected boolean pastRoot
precomputedPrefixes
protected static final String[] precomputedPrefixes
seenBracket
protected boolean seenBracket
seenBracketBracket
protected boolean seenBracketBracket
seenTag
protected boolean seenTag
setPrefixCalled
protected boolean setPrefixCalled
startTagIncomplete
protected boolean startTagIncomplete
writeIndentation
protected boolean writeIndentation
writeLineSepartor
protected boolean writeLineSepartor
attribute
public XmlSerializer attribute(String namespace,
String name,
String value)
throws IOException
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.
- attribute in interface XmlSerializer
closeStartTag
protected void closeStartTag()
throws IOException
endDocument
public void endDocument()
throws IOException
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()
- endDocument in interface XmlSerializer
endTag
public XmlSerializer endTag(String namespace,
String name)
throws IOException
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='').
- endTag in interface XmlSerializer
ensureElementsCapacity
protected void ensureElementsCapacity()
ensureNamespacesCapacity
protected void ensureNamespacesCapacity()
flush
public void flush()
throws IOException
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("")).
- flush in interface XmlSerializer
getDepth
public 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
- getDepth in interface XmlSerializer
getFeature
public boolean getFeature(String name)
throws IllegalArgumentException
Return the current value of the feature with given name.
NOTE: unknown properties are
always returned as null
- getFeature in interface XmlSerializer
name
- The name of feature to be retrieved.
- The value of named feature.
getName
public 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().
- getName in interface XmlSerializer
- namespace set by startTag() that is currently in scope
getNamespace
public 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
- getNamespace in interface XmlSerializer
- namespace set by startTag() that is currently in scope
getPrefix
public String getPrefix(String namespace,
boolean generatePrefix)
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
- getPrefix in interface XmlSerializer
getProperty
public Object getProperty(String name)
throws IllegalArgumentException
Look up the value of a property.
The property name is any fully-qualified URI. I
NOTE: unknown properties are
always returned as null
- getProperty in interface XmlSerializer
name
- The name of property to be retrieved.
- The value of named property.
getWriter
public Writer getWriter()
lookupOrDeclarePrefix
protected String lookupOrDeclarePrefix(String namespace)
printable
protected static final String printable(String s)
simple utility method -- good for debugging
printable
protected static final String printable(char ch)
rebuildIndentationBuf
protected void rebuildIndentationBuf()
For maximum efficiency when writing indents the required output is pre-computed
This is internal function that recomputes buffer after user requested chnages.
reset
protected void reset()
setFeature
public void setFeature(String name,
boolean state)
throws IllegalArgumentException,
IllegalStateException
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.
- setFeature in interface XmlSerializer
setOutput
public void setOutput(OutputStream os,
String encoding)
throws IOException
Set to use binary output stream with given encoding.
- setOutput in interface XmlSerializer
setOutput
public void setOutput(Writer writer)
Set the output to the given writer.
WARNING no information about encoding is available!
- setOutput in interface XmlSerializer
setPrefix
public void setPrefix(String prefix,
String namespace)
throws IOException
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.
- setPrefix in interface XmlSerializer
prefix
- must be not null (or IllegalArgumentException is thrown)namespace
- must be not null
setProperty
public void setProperty(String name,
Object value)
throws IllegalArgumentException,
IllegalStateException
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.
- setProperty in interface XmlSerializer
startDocument
public void startDocument(String encoding,
Boolean standalone)
throws IOException
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.
- startDocument in interface XmlSerializer
startTag
public XmlSerializer startTag(String namespace,
String name)
throws IOException
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.
- startTag in interface XmlSerializer
text
public XmlSerializer text(String text)
throws IOException
Writes text, where special XML chars are escaped automatically
- text in interface XmlSerializer
text
public XmlSerializer text(char[] buf,
int start,
int len)
throws IOException
Writes text, where special XML chars are escaped automatically
- text in interface XmlSerializer
writeAttributeValue
protected void writeAttributeValue(String value,
Writer out)
throws IOException
writeElementContent
protected void writeElementContent(String text,
Writer out)
throws IOException
writeElementContent
protected void writeElementContent(char[] buf,
int off,
int len,
Writer out)
throws IOException
writeIndent
protected void writeIndent()
throws IOException