public class FastXmlSerializer extends Object implements XmlSerializer
Constructor and Description |
---|
FastXmlSerializer() |
Modifier and Type | Method and Description |
---|---|
XmlSerializer |
attribute(String namespace,
String name,
String value)
Write an attribute.
|
void |
cdsect(String text) |
void |
comment(String text) |
void |
docdecl(String text) |
void |
endDocument()
Finish writing.
|
XmlSerializer |
endTag(String namespace,
String name)
Write end tag.
|
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.
|
void |
ignorableWhitespace(String text) |
void |
processingInstruction(String text) |
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
|
public XmlSerializer attribute(String namespace, String name, String value) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
attribute
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void cdsect(String text) throws IOException, IllegalArgumentException, IllegalStateException
cdsect
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void comment(String text) throws IOException, IllegalArgumentException, IllegalStateException
comment
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void docdecl(String text) throws IOException, IllegalArgumentException, IllegalStateException
docdecl
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void endDocument() throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
endDocument
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public XmlSerializer endTag(String namespace, String name) throws IOException, IllegalArgumentException, IllegalStateException
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
IOException
IllegalArgumentException
IllegalStateException
public void entityRef(String text) throws IOException, IllegalArgumentException, IllegalStateException
entityRef
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void flush() throws 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
IOException
public int getDepth()
XmlSerializer
<!-- outside --> 0 <root> 1 sometext 1 <foobar> 2 </foobar> 2 </root> 1 <!-- outside --> 0
getDepth
in interface XmlSerializer
public boolean getFeature(String name)
XmlSerializer
NOTE: unknown properties are always returned as null
getFeature
in interface XmlSerializer
name
- The name of feature to be retrieved.public String getName()
XmlSerializer
getName
in interface XmlSerializer
public String getNamespace()
XmlSerializer
NOTE: that means in particular that:
getNamespace
in interface XmlSerializer
public String getPrefix(String namespace, boolean generatePrefix) throws IllegalArgumentException
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
IllegalArgumentException
public Object getProperty(String name)
XmlSerializer
NOTE: unknown properties are
getProperty
in interface XmlSerializer
name
- The name of property to be retrieved.public void ignorableWhitespace(String text) throws IOException, IllegalArgumentException, IllegalStateException
ignorableWhitespace
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void processingInstruction(String text) throws IOException, IllegalArgumentException, IllegalStateException
processingInstruction
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void setFeature(String name, boolean state) throws IllegalArgumentException, IllegalStateException
XmlSerializer
setFeature
in interface XmlSerializer
IllegalStateException
- If the feature is not supported or can not be setIllegalArgumentException
public void setOutput(OutputStream os, String encoding) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
setOutput
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void setOutput(Writer writer) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
WARNING no information about encoding is available!
setOutput
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public void setPrefix(String prefix, String namespace) throws IOException, IllegalArgumentException, IllegalStateException
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 nullIOException
IllegalArgumentException
IllegalStateException
public void setProperty(String name, Object value) throws IllegalArgumentException, IllegalStateException
XmlSerializer
setProperty
in interface XmlSerializer
IllegalStateException
- if the property is not supported or can not be setIllegalArgumentException
public void startDocument(String encoding, Boolean standalone) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
startDocument
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public XmlSerializer startTag(String namespace, String name) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
startTag
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public XmlSerializer text(char[] buf, int start, int len) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
text
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException
public XmlSerializer text(String text) throws IOException, IllegalArgumentException, IllegalStateException
XmlSerializer
text
in interface XmlSerializer
IOException
IllegalArgumentException
IllegalStateException