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
FieldsModifier and TypeFieldDescriptionprotected booleanprotected intprotected char[]private static final intprivate booleanprotected intprotected booleanprotected String[]protected String[]protected int[]protected final Stringprotected final Stringprotected booleanprotected char[]protected intprotected Stringprotected Stringprotected Stringprotected intprotected booleanprotected intprotected String[]protected String[]protected intprotected Writerprotected booleanprotected static final String[]protected static final Stringprotected final Stringprotected final Stringprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprivate static final booleanprotected booleanprotected booleanprotected static final Stringprotected static final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static voidaddPrintable(StringBuilder retval, char ch) Write an attribute.voidprivate voidcheckInterning(String name) protected voidvoidvoidvoidFinish writing.Write end tag.protected voidprotected voidvoidvoidflush()Write all pending output to the stream.private StringgeneratePrefix(String namespace) intgetDepth()Returns the current depth of the element.booleangetFeature(String name) Return the current value of the feature with given name.private StringgetName()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.voidignorableWhitespace(String text) protected StringlookupOrDeclarePrefix(String namespace) protected static final Stringprintable(char ch) protected static final Stringsimple utility method -- good for debuggingvoidprocessingInstruction(String text) protected voidFor maximum efficiency when writing indents the required output is pre-computed This is internal function that recomputes buffer after user requested changes.protected voidreset()voidsetFeature(String name, boolean state) Set feature identified by name (recommended to be URI for uniqueness).voidsetOutput(OutputStream os, String encoding) Set to use binary output stream with given encoding.voidSet the output to the given writer.voidBinds the given prefix to the given namespace.voidsetProperty(String name, Object value) Set the value of a property.voidstartDocument(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 automaticallyprotected voidwriteAttributeValue(String value, Writer out) protected voidwriteElementContent(char[] buf, int off, int len, Writer out) protected voidwriteElementContent(String text, Writer out) protected voidprivate void
-
Field Details
-
XML_URI
- See Also:
-
XMLNS_URI
- See Also:
-
TRACE_SIZING
private static final boolean TRACE_SIZING- 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_LEN
private static final int BUF_LEN -
buf
protected char[] buf -
precomputedPrefixes
-
checkNamesInterned
private boolean checkNamesInterned -
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
-
checkInterning
-
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:XmlSerializerSet 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:
setFeaturein interfaceXmlSerializer- Throws:
IllegalStateException- If the feature is not supported or can not be setIllegalArgumentException
-
getFeature
Description copied from interface:XmlSerializerReturn the current value of the feature with given name.NOTE: unknown properties are always returned as null
- Specified by:
getFeaturein 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:XmlSerializerSet 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:
setPropertyin interfaceXmlSerializer- Throws:
IllegalStateException- if the property is not supported or can not be setIllegalArgumentException
-
getProperty
Description copied from interface:XmlSerializerLook up the value of a property. The property name is any fully-qualified URI. INOTE: unknown properties are always returned as null
- Specified by:
getPropertyin interfaceXmlSerializer- Parameters:
name- The name of property to be retrieved.- Returns:
- The value of named property.
- Throws:
IllegalArgumentException
-
getLocation
-
getWriter
-
setOutput
Description copied from interface:XmlSerializerSet the output to the given writer.WARNING no information about encoding is available!
- Specified by:
setOutputin interfaceXmlSerializer
-
setOutput
Description copied from interface:XmlSerializerSet to use binary output stream with given encoding.- Specified by:
setOutputin interfaceXmlSerializer- Throws:
IOException
-
startDocument
Description copied from interface:XmlSerializerWrite <?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:
startDocumentin interfaceXmlSerializer- Throws:
IOException
-
endDocument
Description copied from interface:XmlSerializerFinish 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:
endDocumentin interfaceXmlSerializer- Throws:
IOException
-
setPrefix
Description copied from interface:XmlSerializerBinds 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:
setPrefixin interfaceXmlSerializer- Parameters:
prefix- must be not null (or IllegalArgumentException is thrown)namespace- must be not null- Throws:
IOException
-
lookupOrDeclarePrefix
-
getPrefix
Description copied from interface:XmlSerializerReturn 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
- Specified by:
getPrefixin interfaceXmlSerializer
-
generatePrefix
-
getDepth
public int getDepth()Description copied from interface:XmlSerializerReturns 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- Specified by:
getDepthin interfaceXmlSerializer
-
getNamespace
Description copied from interface:XmlSerializerReturns 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:
getNamespacein interfaceXmlSerializer- Returns:
- namespace set by startTag() that is currently in scope
-
getName
Description copied from interface:XmlSerializerReturns 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:
getNamein interfaceXmlSerializer- Returns:
- namespace set by startTag() that is currently in scope
-
startTag
Description copied from interface:XmlSerializerWrites 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:
startTagin interfaceXmlSerializer- Throws:
IOException
-
attribute
Description copied from interface:XmlSerializerWrite 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:
attributein interfaceXmlSerializer- Throws:
IOException
-
closeStartTag
- Throws:
IOException
-
writeNamespaceDeclarations
- Throws:
IOException
-
endTag
Description copied from interface:XmlSerializerWrite 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:
endTagin interfaceXmlSerializer- Throws:
IOException
-
text
Description copied from interface:XmlSerializerWrites text, where special XML chars are escaped automatically- Specified by:
textin interfaceXmlSerializer- Throws:
IOException
-
text
Description copied from interface:XmlSerializerWrites text, where special XML chars are escaped automatically- Specified by:
textin interfaceXmlSerializer- Throws:
IOException
-
cdsect
- Specified by:
cdsectin interfaceXmlSerializer- Throws:
IOException
-
entityRef
- Specified by:
entityRefin interfaceXmlSerializer- Throws:
IOException
-
processingInstruction
- Specified by:
processingInstructionin interfaceXmlSerializer- Throws:
IOException
-
comment
- Specified by:
commentin interfaceXmlSerializer- Throws:
IOException
-
docdecl
- Specified by:
docdeclin interfaceXmlSerializer- Throws:
IOException
-
ignorableWhitespace
- Specified by:
ignorableWhitespacein interfaceXmlSerializer- Throws:
IOException
-
flush
Description copied from interface:XmlSerializerWrite 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:
flushin interfaceXmlSerializer- Throws:
IOException
-
writeAttributeValue
- Throws:
IOException
-
writeElementContent
- Throws:
IOException
-
writeElementContent
- Throws:
IOException
-
printable
simple utility method -- good for debugging -
printable
-
addPrintable
-