|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kxml2.io.KXmlSerializer
public class KXmlSerializer
Field Summary | |
---|---|
private int |
auto
|
private int |
depth
|
private java.lang.String[] |
elementStack
|
private java.lang.String |
encoding
|
private boolean[] |
indent
|
private int[] |
nspCounts
|
private java.lang.String[] |
nspStack
|
private boolean |
pending
|
private boolean |
unicode
|
private java.io.Writer |
writer
|
Constructor Summary | |
---|---|
KXmlSerializer()
|
Method Summary | |
---|---|
XmlSerializer |
attribute(java.lang.String namespace,
java.lang.String name,
java.lang.String value)
Write an attribute. |
void |
cdsect(java.lang.String data)
|
private void |
check(boolean close)
|
void |
comment(java.lang.String comment)
|
void |
docdecl(java.lang.String dd)
|
void |
endDocument()
Finish writing. |
XmlSerializer |
endTag(java.lang.String namespace,
java.lang.String name)
Write end tag. |
void |
entityRef(java.lang.String name)
|
void |
flush()
Write all pending output to the stream. |
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. |
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 create)
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. |
private java.lang.String |
getPrefix(java.lang.String namespace,
boolean includeDefault,
boolean create)
|
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property. |
void |
ignorableWhitespace(java.lang.String s)
|
void |
processingInstruction(java.lang.String pi)
|
void |
setFeature(java.lang.String name,
boolean value)
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[] text,
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 |
private void |
writeEscaped(java.lang.String s,
int quot)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.io.Writer writer
private boolean pending
private int auto
private int depth
private java.lang.String[] elementStack
private int[] nspCounts
private java.lang.String[] nspStack
private boolean[] indent
private boolean unicode
private java.lang.String encoding
Constructor Detail |
---|
public KXmlSerializer()
Method Detail |
---|
private final void check(boolean close) throws java.io.IOException
java.io.IOException
private final void writeEscaped(java.lang.String s, int quot) throws java.io.IOException
java.io.IOException
public void docdecl(java.lang.String dd) throws java.io.IOException
docdecl
in interface XmlSerializer
java.io.IOException
public void endDocument() throws java.io.IOException
XmlSerializer
endDocument
in interface XmlSerializer
java.io.IOException
public void entityRef(java.lang.String name) throws java.io.IOException
entityRef
in interface XmlSerializer
java.io.IOException
public boolean getFeature(java.lang.String name)
XmlSerializer
NOTE: unknown properties are always returned as null
getFeature
in interface XmlSerializer
name
- The name of feature to be retrieved.
public java.lang.String getPrefix(java.lang.String namespace, boolean create)
XmlSerializer
NOTE: if the prefix is empty string "" and defualt 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 final java.lang.String getPrefix(java.lang.String namespace, boolean includeDefault, boolean create) throws java.io.IOException
java.io.IOException
public java.lang.Object getProperty(java.lang.String name)
XmlSerializer
NOTE: unknown properties are
getProperty
in interface XmlSerializer
name
- The name of property to be retrieved.
public void ignorableWhitespace(java.lang.String s) throws java.io.IOException
ignorableWhitespace
in interface XmlSerializer
java.io.IOException
public void setFeature(java.lang.String name, boolean value)
XmlSerializer
setFeature
in interface XmlSerializer
public void setProperty(java.lang.String name, java.lang.Object value)
XmlSerializer
setProperty
in interface XmlSerializer
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 null
java.io.IOException
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 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
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 flushinging output call method text() with empty string (text("")).
flush
in interface XmlSerializer
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 serialzier will make sure that default empty namespace is declared (in XML 1.0 xmlns='').
endTag
in interface XmlSerializer
java.io.IOException
public java.lang.String getNamespace()
XmlSerializer
NOTE: that measn in particaulr that:
getNamespace
in interface XmlSerializer
public java.lang.String getName()
XmlSerializer
getName
in interface XmlSerializer
public int getDepth()
XmlSerializer
<!-- outside --> 0 <root> 1 sometext 1 <foobar> 2 </foobar> 2 </root> 1 <!-- outside --> 0
getDepth
in interface XmlSerializer
public XmlSerializer text(java.lang.String text) throws java.io.IOException
XmlSerializer
text
in interface XmlSerializer
java.io.IOException
public XmlSerializer text(char[] text, int start, int len) throws java.io.IOException
XmlSerializer
text
in interface XmlSerializer
java.io.IOException
public void cdsect(java.lang.String data) throws java.io.IOException
cdsect
in interface XmlSerializer
java.io.IOException
public void comment(java.lang.String comment) throws java.io.IOException
comment
in interface XmlSerializer
java.io.IOException
public void processingInstruction(java.lang.String pi) throws java.io.IOException
processingInstruction
in interface XmlSerializer
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |