Class MXSerializer
- All Implemented Interfaces:
XmlSerializer
Implemented features:
- FEATURE_NAMES_INTERNED - when enabled all returned names (namespaces, prefixes) will be interned and it is required that all names passed as arguments MUST be interned
- FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
Implemented properties:
- PROPERTY_SERIALIZER_INDENTATION
- PROPERTY_SERIALIZER_LINE_SEPARATOR
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected int
protected char[]
protected int
protected boolean
protected String[]
protected String[]
protected int[]
protected final String
protected final String
protected boolean
protected char[]
protected int
protected String
protected String
protected String
protected int
protected boolean
protected int
protected String[]
protected String[]
protected int
protected Writer
protected boolean
protected static final String[]
protected static final String
protected final String
protected final String
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected static final String
protected static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionWrite an attribute.void
protected void
void
void
void
Finish writing.Write end tag.protected void
protected void
void
void
flush()
Write all pending output to the stream.int
getDepth()
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().getProperty
(String name) Look up the value of a property.void
ignorableWhitespace
(String text) protected String
lookupOrDeclarePrefix
(String namespace) protected static final String
printable
(char ch) protected static final String
void
processingInstruction
(String text) protected void
For maximum efficiency when writing indents the required output is pre-computed This is internal function that recomputes buffer after user requested changes.protected void
reset()
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
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 automaticallyprotected void
writeAttributeValue
(String value, Writer out) protected void
writeElementContent
(char[] buf, int off, int len, Writer out) protected void
writeElementContent
(String text, Writer out) protected void
-
Field Details
-
XML_URI
- See Also:
-
XMLNS_URI
- See Also:
-
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
- See Also:
-
FEATURE_NAMES_INTERNED
- See Also:
-
PROPERTY_SERIALIZER_INDENTATION
- See Also:
-
PROPERTY_SERIALIZER_LINE_SEPARATOR
- See Also:
-
PROPERTY_LOCATION
- See Also:
-
namesInterned
protected boolean namesInterned -
attributeUseApostrophe
protected boolean attributeUseApostrophe -
indentationString
-
lineSeparator
-
location
-
out
-
autoDeclaredPrefixes
protected int autoDeclaredPrefixes -
depth
protected int depth -
elNamespace
-
elName
-
elNamespaceCount
protected int[] elNamespaceCount -
namespaceEnd
protected int namespaceEnd -
namespacePrefix
-
namespaceUri
-
finished
protected boolean finished -
pastRoot
protected boolean pastRoot -
setPrefixCalled
protected boolean setPrefixCalled -
startTagIncomplete
protected boolean startTagIncomplete -
doIndent
protected boolean doIndent -
seenTag
protected boolean seenTag -
seenBracket
protected boolean seenBracket -
seenBracketBracket
protected boolean seenBracketBracket -
buf
protected char[] buf -
precomputedPrefixes
-
offsetNewLine
protected int offsetNewLine -
indentationJump
protected int indentationJump -
indentationBuf
protected char[] indentationBuf -
maxIndentLevel
protected int maxIndentLevel -
writeLineSeparator
protected boolean writeLineSeparator -
writeIndentation
protected boolean writeIndentation
-
-
Constructor Details
-
MXSerializer
public MXSerializer()
-
-
Method Details
-
reset
protected void reset() -
ensureElementsCapacity
protected void ensureElementsCapacity() -
ensureNamespacesCapacity
protected void ensureNamespacesCapacity() -
setFeature
public void setFeature(String name, boolean state) throws IllegalArgumentException, IllegalStateException Description copied from interface:XmlSerializer
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 recognized or can not be set then IllegalStateException MUST be thrown.- Specified by:
setFeature
in interfaceXmlSerializer
- Parameters:
name
- feature namestate
- feature state- Throws:
IllegalStateException
- If the feature is not supported or can not be setIllegalArgumentException
-
getFeature
Description copied from interface:XmlSerializer
Return the current value of the feature with given name.NOTE: unknown properties are always returned as null
- Specified by:
getFeature
in interfaceXmlSerializer
- Parameters:
name
- The name of feature to be retrieved.- Returns:
- The value of named feature.
- Throws:
IllegalArgumentException
- if feature string is null
-
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 changes. -
writeIndent
- Throws:
IOException
-
setProperty
public void setProperty(String name, Object value) throws IllegalArgumentException, IllegalStateException Description copied from interface:XmlSerializer
Set the value of a property. (the property name is recommended 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 recognized or can not be set then IllegalStateException MUST be thrown.- Specified by:
setProperty
in interfaceXmlSerializer
- Parameters:
name
- property namevalue
- property value- Throws:
IllegalStateException
- if the property is not supported or can not be setIllegalArgumentException
-
getProperty
Description copied from interface:XmlSerializer
Look up the value of a property. The property name is any fully-qualified URI. INOTE: unknown properties are always returned as null
- Specified by:
getProperty
in interfaceXmlSerializer
- Parameters:
name
- The name of property to be retrieved.- Returns:
- The value of named property.
- Throws:
IllegalArgumentException
-
getWriter
-
setOutput
- Specified by:
setOutput
in interfaceXmlSerializer
- Parameters:
writer
- Set the output to the given writer.WARNING no information about encoding is available!
-
setOutput
Description copied from interface:XmlSerializer
Set to use binary output stream with given encoding.- Specified by:
setOutput
in interfaceXmlSerializer
- Parameters:
os
- outencoding
- encoding- Throws:
IOException
- io
-
startDocument
Description copied from interface:XmlSerializer
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.- Specified by:
startDocument
in interfaceXmlSerializer
- Parameters:
encoding
- document encodingstandalone
- standalone flag value- Throws:
IOException
- io
-
endDocument
Description copied from interface:XmlSerializer
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()- Specified by:
endDocument
in interfaceXmlSerializer
- Throws:
IOException
- io
-
setPrefix
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 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.
- Specified by:
setPrefix
in interfaceXmlSerializer
- Parameters:
prefix
- must be not null (or IllegalArgumentException is thrown)namespace
- must be not null- Throws:
IOException
- io
-
lookupOrDeclarePrefix
-
getPrefix
- Specified by:
getPrefix
in interfaceXmlSerializer
- Parameters:
namespace
- the namespacegeneratePrefix
- to generate the missing prefix- Returns:
- 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 default 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
-
getDepth
public int getDepth()- Specified by:
getDepth
in interfaceXmlSerializer
- 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
Description copied from interface:XmlSerializer
Returns the namespace URI of the current element as set by startTag().NOTE: that means in particular that:
- if there was startTag("", ...) then getNamespace() returns ""
- if there was startTag(null, ...) then getNamespace() returns null
- Specified by:
getNamespace
in interfaceXmlSerializer
- Returns:
- namespace set by startTag() that is currently in scope
-
getName
Description copied from interface:XmlSerializer
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().- Specified by:
getName
in interfaceXmlSerializer
- Returns:
- namespace set by startTag() that is currently in scope
-
startTag
Description copied from interface:XmlSerializer
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 serializer 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.- Specified by:
startTag
in interfaceXmlSerializer
- Parameters:
namespace
- nsname
- tag name- Returns:
- XmlSerializer
- Throws:
IOException
- io
-
attribute
Description copied from interface:XmlSerializer
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.- Specified by:
attribute
in interfaceXmlSerializer
- Parameters:
namespace
- namespace to usename
- attribute namevalue
- attribute value- Returns:
- XmlSerializer
- Throws:
IOException
- io
-
closeStartTag
- Throws:
IOException
-
endTag
Description copied from interface:XmlSerializer
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 serializer will make sure that default empty namespace is declared (in XML 1.0 xmlns='').- Specified by:
endTag
in interfaceXmlSerializer
- Parameters:
namespace
- nsname
- tag name- Returns:
- XmlSerializer
- Throws:
IOException
- io
-
text
- Specified by:
text
in interfaceXmlSerializer
- Parameters:
text
- Writes text, where special XML chars are escaped automatically- Returns:
- XmlSerializer
- Throws:
IOException
- io
-
text
Description copied from interface:XmlSerializer
Writes text, where special XML chars are escaped automatically- Specified by:
text
in interfaceXmlSerializer
- Parameters:
buf
- charactersstart
- startlen
- lenght- Returns:
- XmlSerializer
- Throws:
IOException
- io
-
cdsect
- Specified by:
cdsect
in interfaceXmlSerializer
- Throws:
IOException
-
entityRef
- Specified by:
entityRef
in interfaceXmlSerializer
- Throws:
IOException
-
processingInstruction
- Specified by:
processingInstruction
in interfaceXmlSerializer
- Throws:
IOException
-
comment
- Specified by:
comment
in interfaceXmlSerializer
- Throws:
IOException
-
docdecl
- Specified by:
docdecl
in interfaceXmlSerializer
- Throws:
IOException
-
ignorableWhitespace
- Specified by:
ignorableWhitespace
in interfaceXmlSerializer
- Throws:
IOException
-
flush
Description copied from interface:XmlSerializer
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 flushing output call method text() with empty string (text("")).
- Specified by:
flush
in interfaceXmlSerializer
- Throws:
IOException
- io
-
writeAttributeValue
- Throws:
IOException
-
writeElementContent
- Throws:
IOException
-
writeElementContent
- Throws:
IOException
-
printable
-
printable
-