public class MXSerializer extends Object implements XmlSerializer
Implemented features:
Implemented properties:
| Modifier and Type | Field and Description |
|---|---|
protected boolean |
attributeUseApostrophe |
protected int |
autoDeclaredPrefixes |
protected char[] |
buf |
protected int |
depth |
protected boolean |
doIndent |
protected String[] |
elName |
protected String[] |
elNamespace |
protected int[] |
elNamespaceCount |
protected String |
FEATURE_NAMES_INTERNED |
protected String |
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE |
protected boolean |
finished |
protected char[] |
indentationBuf |
protected int |
indentationJump |
protected String |
indentationString |
protected String |
lineSeparator |
protected String |
location |
protected int |
maxIndentLevel |
protected boolean |
namesInterned |
protected int |
namespaceEnd |
protected String[] |
namespacePrefix |
protected String[] |
namespaceUri |
protected int |
offsetNewLine |
protected Writer |
out |
protected boolean |
pastRoot |
protected static String[] |
precomputedPrefixes |
protected static String |
PROPERTY_LOCATION |
protected String |
PROPERTY_SERIALIZER_INDENTATION |
protected String |
PROPERTY_SERIALIZER_LINE_SEPARATOR |
protected boolean |
seenBracket |
protected boolean |
seenBracketBracket |
protected boolean |
seenTag |
protected boolean |
setPrefixCalled |
protected boolean |
startTagIncomplete |
protected boolean |
writeIndentation |
protected boolean |
writeLineSepartor |
protected static String |
XML_URI |
protected static String |
XMLNS_URI |
| Constructor and Description |
|---|
MXSerializer() |
| Modifier and Type | Method and Description |
|---|---|
XmlSerializer |
attribute(String namespace,
String name,
String value)
Write an attribute.
|
void |
cdsect(String text) |
protected void |
closeStartTag() |
void |
comment(String text) |
void |
docdecl(String text) |
void |
endDocument()
Finish writing.
|
XmlSerializer |
endTag(String namespace,
String name)
Write end tag.
|
protected void |
ensureElementsCapacity() |
protected void |
ensureNamespacesCapacity() |
void |
entityRef(String text) |
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.
|
String |
getName()
Returns the name of the current element as set by startTag().
|
String |
getNamespace()
Returns the namespace URI of the current element as set by startTag().
|
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.
|
Object |
getProperty(String name)
Look up the value of a property.
|
Writer |
getWriter() |
void |
ignorableWhitespace(String text) |
protected String |
lookupOrDeclarePrefix(String namespace) |
protected static String |
printable(char ch) |
protected static String |
printable(String s)
simple utility method -- good for debugging
|
void |
processingInstruction(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 chnages.
|
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 |
setOutput(Writer writer)
Set the output to the given writer.
|
void |
setPrefix(String prefix,
String namespace)
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.
|
XmlSerializer |
startTag(String namespace,
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(String text)
Writes text, where special XML chars are escaped automatically
|
protected 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 |
writeIndent() |
protected static final String XML_URI
protected static final String XMLNS_URI
protected final String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected final String FEATURE_NAMES_INTERNED
protected final String PROPERTY_SERIALIZER_INDENTATION
protected final String PROPERTY_SERIALIZER_LINE_SEPARATOR
protected static final String PROPERTY_LOCATION
protected boolean namesInterned
protected boolean attributeUseApostrophe
protected String indentationString
protected String lineSeparator
protected String location
protected Writer out
protected int autoDeclaredPrefixes
protected int depth
protected String[] elNamespace
protected String[] elName
protected int[] elNamespaceCount
protected int namespaceEnd
protected String[] namespacePrefix
protected 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
protected char[] buf
protected static final String[] precomputedPrefixes
protected int offsetNewLine
protected int indentationJump
protected char[] indentationBuf
protected int maxIndentLevel
protected boolean writeLineSepartor
protected boolean writeIndentation
protected void reset()
protected void ensureElementsCapacity()
protected void ensureNamespacesCapacity()
public void setFeature(String name, boolean state) throws IllegalArgumentException, IllegalStateException
XmlSerializersetFeature in interface XmlSerializerIllegalStateException - If the feature is not supported or can not be setIllegalArgumentExceptionpublic boolean getFeature(String name) throws IllegalArgumentException
XmlSerializerNOTE: unknown properties are always returned as null
getFeature in interface XmlSerializername - The name of feature to be retrieved.IllegalArgumentException - if feature string is nullprotected void rebuildIndentationBuf()
protected void writeIndent()
throws IOException
IOExceptionpublic void setProperty(String name, Object value) throws IllegalArgumentException, IllegalStateException
XmlSerializersetProperty in interface XmlSerializerIllegalStateException - if the property is not supported or can not be setIllegalArgumentExceptionpublic Object getProperty(String name) throws IllegalArgumentException
XmlSerializerNOTE: unknown properties are
getProperty in interface XmlSerializername - The name of property to be retrieved.IllegalArgumentExceptionpublic Writer getWriter()
public void setOutput(Writer writer)
XmlSerializerWARNING no information about encoding is available!
setOutput in interface XmlSerializerpublic void setOutput(OutputStream os, String encoding) throws IOException
XmlSerializersetOutput in interface XmlSerializerIOExceptionpublic void startDocument(String encoding, Boolean standalone) throws IOException
XmlSerializerstartDocument in interface XmlSerializerIOExceptionpublic void endDocument()
throws IOException
XmlSerializerendDocument in interface XmlSerializerIOExceptionpublic void setPrefix(String prefix, String namespace) throws IOException
XmlSerializerxmlns: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 XmlSerializerprefix - must be not null (or IllegalArgumentException is thrown)namespace - must be not nullIOExceptionpublic String getPrefix(String namespace, boolean generatePrefix)
XmlSerializerNOTE: 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 XmlSerializerpublic int getDepth()
XmlSerializer
<!-- outside --> 0
<root> 1
sometext 1
<foobar> 2
</foobar> 2
</root> 1
<!-- outside --> 0
getDepth in interface XmlSerializerpublic String getNamespace()
XmlSerializerNOTE: that means in particular that:
getNamespace in interface XmlSerializerpublic String getName()
XmlSerializergetName in interface XmlSerializerpublic XmlSerializer startTag(String namespace, String name) throws IOException
XmlSerializerstartTag in interface XmlSerializerIOExceptionpublic XmlSerializer attribute(String namespace, String name, String value) throws IOException
XmlSerializerattribute in interface XmlSerializerIOExceptionprotected void closeStartTag()
throws IOException
IOExceptionpublic XmlSerializer endTag(String namespace, String name) throws IOException
XmlSerializerBackground: 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 XmlSerializerIOExceptionpublic XmlSerializer text(String text) throws IOException
XmlSerializertext in interface XmlSerializerIOExceptionpublic XmlSerializer text(char[] buf, int start, int len) throws IOException
XmlSerializertext in interface XmlSerializerIOExceptionpublic void cdsect(String text) throws IOException
cdsect in interface XmlSerializerIOExceptionpublic void entityRef(String text) throws IOException
entityRef in interface XmlSerializerIOExceptionpublic void processingInstruction(String text) throws IOException
processingInstruction in interface XmlSerializerIOExceptionpublic void comment(String text) throws IOException
comment in interface XmlSerializerIOExceptionpublic void docdecl(String text) throws IOException
docdecl in interface XmlSerializerIOExceptionpublic void ignorableWhitespace(String text) throws IOException
ignorableWhitespace in interface XmlSerializerIOExceptionpublic void flush()
throws IOException
XmlSerializerNOTE: 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 XmlSerializerIOExceptionprotected void writeAttributeValue(String value, Writer out) throws IOException
IOExceptionprotected void writeElementContent(String text, Writer out) throws IOException
IOExceptionprotected void writeElementContent(char[] buf,
int off,
int len,
Writer out)
throws IOException
IOExceptionprotected static final String printable(String s)
protected static final String printable(char ch)
Copyright © 2001-2014 Codehaus. All Rights Reserved.