public class MXSerializer extends java.lang.Object implements XmlSerializer
Implemented features:
Implemented properties:
Modifier and Type | Field and Description |
---|---|
protected boolean |
attributeUseApostrophe |
protected int |
autoDeclaredPrefixes |
protected char[] |
buf |
private static int |
BUF_LEN |
private boolean |
checkNamesInterned |
protected int |
depth |
protected boolean |
doIndent |
protected java.lang.String[] |
elName |
protected java.lang.String[] |
elNamespace |
protected int[] |
elNamespaceCount |
protected java.lang.String |
FEATURE_NAMES_INTERNED |
protected java.lang.String |
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE |
protected boolean |
finished |
protected char[] |
indentationBuf |
protected int |
indentationJump |
protected java.lang.String |
indentationString |
protected java.lang.String |
lineSeparator |
protected java.lang.String |
location |
protected int |
maxIndentLevel |
protected boolean |
namesInterned |
protected int |
namespaceEnd |
protected java.lang.String[] |
namespacePrefix |
protected java.lang.String[] |
namespaceUri |
protected int |
offsetNewLine |
protected java.io.Writer |
out |
protected boolean |
pastRoot |
protected static java.lang.String[] |
precomputedPrefixes |
protected static java.lang.String |
PROPERTY_LOCATION |
protected java.lang.String |
PROPERTY_SERIALIZER_INDENTATION |
protected java.lang.String |
PROPERTY_SERIALIZER_LINE_SEPARATOR |
protected boolean |
seenBracket |
protected boolean |
seenBracketBracket |
protected boolean |
seenTag |
protected boolean |
setPrefixCalled |
protected boolean |
startTagIncomplete |
private static boolean |
TRACE_SIZING |
protected boolean |
writeIndentation |
protected boolean |
writeLineSeparator |
protected static java.lang.String |
XML_URI |
protected static java.lang.String |
XMLNS_URI |
Constructor and Description |
---|
MXSerializer() |
Modifier and Type | Method and Description |
---|---|
private static void |
addPrintable(java.lang.StringBuilder retval,
char ch) |
XmlSerializer |
attribute(java.lang.String namespace,
java.lang.String name,
java.lang.String value)
Write an attribute.
|
void |
cdsect(java.lang.String text) |
private void |
checkInterning(java.lang.String name) |
protected void |
closeStartTag() |
void |
comment(java.lang.String text) |
void |
docdecl(java.lang.String text) |
void |
endDocument()
Finish writing.
|
XmlSerializer |
endTag(java.lang.String namespace,
java.lang.String name)
Write end tag.
|
protected void |
ensureElementsCapacity() |
protected void |
ensureNamespacesCapacity() |
void |
entityRef(java.lang.String text) |
void |
flush()
Write all pending output to the stream.
|
private java.lang.String |
generatePrefix(java.lang.String namespace) |
int |
getDepth()
Returns the current depth of the element.
|
boolean |
getFeature(java.lang.String name)
Return the current value of the feature with given name.
|
private java.lang.String |
getLocation() |
java.lang.String |
getName()
Returns the name of the current element as set by startTag().
|
java.lang.String |
getNamespace()
Returns the namespace URI of the current element as set by startTag().
|
java.lang.String |
getPrefix(java.lang.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.
|
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property.
|
java.io.Writer |
getWriter() |
void |
ignorableWhitespace(java.lang.String text) |
protected java.lang.String |
lookupOrDeclarePrefix(java.lang.String namespace) |
protected static java.lang.String |
printable(char ch) |
protected static java.lang.String |
printable(java.lang.String s)
simple utility method -- good for debugging
|
void |
processingInstruction(java.lang.String text) |
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.
|
protected void |
reset() |
void |
setFeature(java.lang.String name,
boolean state)
Set feature identified by name (recommended to be URI for uniqueness).
|
void |
setOutput(java.io.OutputStream os,
java.lang.String encoding)
Set to use binary output stream with given encoding.
|
void |
setOutput(java.io.Writer writer)
Set the output to the given writer.
|
void |
setPrefix(java.lang.String prefix,
java.lang.String namespace)
Binds the given prefix to the given namespace.
|
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set the value of a property.
|
void |
startDocument(java.lang.String encoding,
java.lang.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.
|
XmlSerializer |
startTag(java.lang.String namespace,
java.lang.String name)
Writes a start tag with the given namespace and name.
|
XmlSerializer |
text(char[] buf,
int start,
int len)
Writes text, where special XML chars are escaped automatically
|
XmlSerializer |
text(java.lang.String text)
Writes text, where special XML chars are escaped automatically
|
protected void |
writeAttributeValue(java.lang.String value,
java.io.Writer out) |
protected void |
writeElementContent(char[] buf,
int off,
int len,
java.io.Writer out) |
protected void |
writeElementContent(java.lang.String text,
java.io.Writer out) |
protected void |
writeIndent() |
private void |
writeNamespaceDeclarations() |
protected static final java.lang.String XML_URI
protected static final java.lang.String XMLNS_URI
private static final boolean TRACE_SIZING
protected final java.lang.String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected final java.lang.String FEATURE_NAMES_INTERNED
protected final java.lang.String PROPERTY_SERIALIZER_INDENTATION
protected final java.lang.String PROPERTY_SERIALIZER_LINE_SEPARATOR
protected static final java.lang.String PROPERTY_LOCATION
protected boolean namesInterned
protected boolean attributeUseApostrophe
protected java.lang.String indentationString
protected java.lang.String lineSeparator
protected java.lang.String location
protected java.io.Writer out
protected int autoDeclaredPrefixes
protected int depth
protected java.lang.String[] elNamespace
protected java.lang.String[] elName
protected int[] elNamespaceCount
protected int namespaceEnd
protected java.lang.String[] namespacePrefix
protected java.lang.String[] namespaceUri
protected boolean finished
protected boolean pastRoot
protected boolean setPrefixCalled
protected boolean startTagIncomplete
protected boolean doIndent
protected boolean seenTag
protected boolean seenBracket
protected boolean seenBracketBracket
private static final int BUF_LEN
protected char[] buf
protected static final java.lang.String[] precomputedPrefixes
private boolean checkNamesInterned
protected int offsetNewLine
protected int indentationJump
protected char[] indentationBuf
protected int maxIndentLevel
protected boolean writeLineSeparator
protected boolean writeIndentation
private void checkInterning(java.lang.String name)
protected void reset()
protected void ensureElementsCapacity()
protected void ensureNamespacesCapacity()
public void setFeature(java.lang.String name, boolean state) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
XmlSerializer
setFeature
in interface XmlSerializer
java.lang.IllegalStateException
- If the feature is not supported or can not be setjava.lang.IllegalArgumentException
public boolean getFeature(java.lang.String name) throws java.lang.IllegalArgumentException
XmlSerializer
NOTE: unknown properties are always returned as null
getFeature
in interface XmlSerializer
name
- The name of feature to be retrieved.java.lang.IllegalArgumentException
- if feature string is nullprotected void rebuildIndentationBuf()
protected void writeIndent() throws java.io.IOException
java.io.IOException
public void setProperty(java.lang.String name, java.lang.Object value) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
XmlSerializer
setProperty
in interface XmlSerializer
java.lang.IllegalStateException
- if the property is not supported or can not be setjava.lang.IllegalArgumentException
public java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
XmlSerializer
NOTE: unknown properties are always returned as null
getProperty
in interface XmlSerializer
name
- The name of property to be retrieved.java.lang.IllegalArgumentException
private java.lang.String getLocation()
public java.io.Writer getWriter()
public void setOutput(java.io.Writer writer)
XmlSerializer
WARNING no information about encoding is available!
setOutput
in interface XmlSerializer
public void setOutput(java.io.OutputStream os, java.lang.String encoding) throws java.io.IOException
XmlSerializer
setOutput
in interface XmlSerializer
java.io.IOException
public void startDocument(java.lang.String encoding, java.lang.Boolean standalone) throws java.io.IOException
XmlSerializer
startDocument
in interface XmlSerializer
java.io.IOException
public void endDocument() throws java.io.IOException
XmlSerializer
endDocument
in interface XmlSerializer
java.io.IOException
public void setPrefix(java.lang.String prefix, java.lang.String namespace) throws java.io.IOException
XmlSerializer
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 nulljava.io.IOException
protected java.lang.String lookupOrDeclarePrefix(java.lang.String namespace)
public java.lang.String getPrefix(java.lang.String namespace, boolean generatePrefix)
XmlSerializer
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
getPrefix
in interface XmlSerializer
private java.lang.String generatePrefix(java.lang.String namespace)
public int getDepth()
XmlSerializer
<!-- outside --> 0 <root> 1 sometext 1 <foobar> 2 </foobar> 2 </root> 1 <!-- outside --> 0
getDepth
in interface XmlSerializer
public java.lang.String getNamespace()
XmlSerializer
NOTE: that means in particular that:
getNamespace
in interface XmlSerializer
public java.lang.String getName()
XmlSerializer
getName
in interface XmlSerializer
public XmlSerializer startTag(java.lang.String namespace, java.lang.String name) throws java.io.IOException
XmlSerializer
startTag
in interface XmlSerializer
java.io.IOException
public XmlSerializer attribute(java.lang.String namespace, java.lang.String name, java.lang.String value) throws java.io.IOException
XmlSerializer
attribute
in interface XmlSerializer
java.io.IOException
protected void closeStartTag() throws java.io.IOException
java.io.IOException
private void writeNamespaceDeclarations() throws java.io.IOException
java.io.IOException
public XmlSerializer endTag(java.lang.String namespace, java.lang.String name) throws java.io.IOException
XmlSerializer
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='').
endTag
in interface XmlSerializer
java.io.IOException
public XmlSerializer text(java.lang.String text) throws java.io.IOException
XmlSerializer
text
in interface XmlSerializer
java.io.IOException
public XmlSerializer text(char[] buf, int start, int len) throws java.io.IOException
XmlSerializer
text
in interface XmlSerializer
java.io.IOException
public void cdsect(java.lang.String text) throws java.io.IOException
cdsect
in interface XmlSerializer
java.io.IOException
public void entityRef(java.lang.String text) throws java.io.IOException
entityRef
in interface XmlSerializer
java.io.IOException
public void processingInstruction(java.lang.String text) throws java.io.IOException
processingInstruction
in interface XmlSerializer
java.io.IOException
public void comment(java.lang.String text) throws java.io.IOException
comment
in interface XmlSerializer
java.io.IOException
public void docdecl(java.lang.String text) throws java.io.IOException
docdecl
in interface XmlSerializer
java.io.IOException
public void ignorableWhitespace(java.lang.String text) throws java.io.IOException
ignorableWhitespace
in interface XmlSerializer
java.io.IOException
public void flush() throws java.io.IOException
XmlSerializer
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("")).
flush
in interface XmlSerializer
java.io.IOException
protected void writeAttributeValue(java.lang.String value, java.io.Writer out) throws java.io.IOException
java.io.IOException
protected void writeElementContent(java.lang.String text, java.io.Writer out) throws java.io.IOException
java.io.IOException
protected void writeElementContent(char[] buf, int off, int len, java.io.Writer out) throws java.io.IOException
java.io.IOException
protected static final java.lang.String printable(java.lang.String s)
protected static final java.lang.String printable(char ch)
private static void addPrintable(java.lang.StringBuilder retval, char ch)