org.kxml2.wap
Class WbxmlSerializer

java.lang.Object
  extended by org.kxml2.wap.WbxmlSerializer
All Implemented Interfaces:
XmlSerializer

public class WbxmlSerializer
extends java.lang.Object
implements XmlSerializer

A class for writing WBXML.


Field Summary
(package private)  java.util.Vector attributes
           
private  int attrPage
           
(package private)  java.util.Hashtable attrStartTable
           
(package private)  java.util.Hashtable attrValueTable
           
(package private)  java.io.ByteArrayOutputStream buf
           
(package private)  int depth
           
private  java.lang.String encoding
           
(package private)  java.lang.String name
           
(package private)  java.lang.String namespace
           
(package private)  java.io.OutputStream out
           
(package private)  java.lang.String pending
           
(package private)  java.util.Hashtable stringTable
           
(package private)  java.io.ByteArrayOutputStream stringTableBuf
           
private  int tagPage
           
(package private)  java.util.Hashtable tagTable
           
 
Constructor Summary
WbxmlSerializer()
           
 
Method Summary
 XmlSerializer attribute(java.lang.String namespace, java.lang.String name, java.lang.String value)
          Write an attribute.
 void cdsect(java.lang.String cdsect)
           
 void checkPending(boolean degenerated)
           
 void comment(java.lang.String comment)
           
 void docdecl(java.lang.String docdecl)
           
 void endDocument()
          Finish writing.
 XmlSerializer endTag(java.lang.String namespace, java.lang.String name)
          Write end tag.
 void entityRef(java.lang.String er)
           
 void flush()
          ATTENTION: flush cannot work since Wbxml documents require need buffering.
 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 nsp, 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.
 java.lang.Object getProperty(java.lang.String name)
          Look up the value of a property.
 void ignorableWhitespace(java.lang.String sp)
           
 void processingInstruction(java.lang.String pi)
           
 void setAttrStartTable(int page, java.lang.String[] attrStartTable)
          Sets the attribute start Table for a given page.
 void setAttrValueTable(int page, java.lang.String[] attrValueTable)
          Sets the attribute value Table for a given page.
 void setFeature(java.lang.String name, boolean value)
          Set feature identified by name (recommended to be URI for uniqueness).
 void setOutput(java.io.OutputStream out, 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 nsp)
          Binds the given prefix to the given namespace.
 void setProperty(java.lang.String property, java.lang.Object value)
          Set the value of a property.
 void setTagTable(int page, java.lang.String[] tagTable)
          Sets the tag table for a given page.
 void startDocument(java.lang.String s, java.lang.Boolean b)
          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[] chars, 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
(package private) static void writeInt(java.io.OutputStream out, int i)
           
 void writeLegacy(int type, java.lang.String data)
          currently ignored!
(package private) static void writeStrI(java.io.OutputStream out, java.lang.String s)
           
(package private)  void writeStrT(java.lang.String s)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

stringTable

java.util.Hashtable stringTable

out

java.io.OutputStream out

buf

java.io.ByteArrayOutputStream buf

stringTableBuf

java.io.ByteArrayOutputStream stringTableBuf

pending

java.lang.String pending

depth

int depth

name

java.lang.String name

namespace

java.lang.String namespace

attributes

java.util.Vector attributes

attrStartTable

java.util.Hashtable attrStartTable

attrValueTable

java.util.Hashtable attrValueTable

tagTable

java.util.Hashtable tagTable

attrPage

private int attrPage

tagPage

private int tagPage

encoding

private java.lang.String encoding
Constructor Detail

WbxmlSerializer

public WbxmlSerializer()
Method Detail

attribute

public XmlSerializer attribute(java.lang.String namespace,
                               java.lang.String name,
                               java.lang.String value)
Description copied from interface: XmlSerializer
Write 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:
attribute in interface XmlSerializer

cdsect

public void cdsect(java.lang.String cdsect)
            throws java.io.IOException
Specified by:
cdsect in interface XmlSerializer
Throws:
java.io.IOException

comment

public void comment(java.lang.String comment)
Specified by:
comment in interface XmlSerializer

docdecl

public void docdecl(java.lang.String docdecl)
Specified by:
docdecl in interface XmlSerializer

entityRef

public void entityRef(java.lang.String er)
Specified by:
entityRef in interface XmlSerializer

getDepth

public int getDepth()
Description copied from interface: XmlSerializer
Returns 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:
getDepth in interface XmlSerializer

getFeature

public boolean getFeature(java.lang.String name)
Description copied from interface: XmlSerializer
Return the current value of the feature with given name.

NOTE: unknown properties are always returned as null

Specified by:
getFeature in interface XmlSerializer
Parameters:
name - The name of feature to be retrieved.
Returns:
The value of named feature.

getNamespace

public java.lang.String getNamespace()
Description copied from interface: XmlSerializer
Returns the namespace URI of the current element as set by startTag().

NOTE: that measn in particaulr that:

Specified by:
getNamespace in interface XmlSerializer
Returns:
namespace set by startTag() that is currently in scope

getName

public java.lang.String getName()
Description copied from interface: XmlSerializer
Returns 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:
getName in interface XmlSerializer
Returns:
namespace set by startTag() that is currently in scope

getPrefix

public java.lang.String getPrefix(java.lang.String nsp,
                                  boolean create)
Description copied from interface: XmlSerializer
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.

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

Specified by:
getPrefix in interface XmlSerializer

getProperty

public java.lang.Object getProperty(java.lang.String name)
Description copied from interface: XmlSerializer
Look up the value of a property. The property name is any fully-qualified URI. I

NOTE: unknown properties are always returned as null

Specified by:
getProperty in interface XmlSerializer
Parameters:
name - The name of property to be retrieved.
Returns:
The value of named property.

ignorableWhitespace

public void ignorableWhitespace(java.lang.String sp)
Specified by:
ignorableWhitespace in interface XmlSerializer

endDocument

public void endDocument()
                 throws java.io.IOException
Description copied from interface: XmlSerializer
Finish 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:
endDocument in interface XmlSerializer
Throws:
java.io.IOException

flush

public void flush()
ATTENTION: flush cannot work since Wbxml documents require need buffering. Thus, this call does nothing.

Specified by:
flush in interface XmlSerializer

checkPending

public void checkPending(boolean degenerated)
                  throws java.io.IOException
Throws:
java.io.IOException

processingInstruction

public void processingInstruction(java.lang.String pi)
Specified by:
processingInstruction in interface XmlSerializer

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
Description copied from interface: XmlSerializer
Set 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 recocgnized or can not be set then IllegalStateException MUST be thrown.

Specified by:
setFeature in interface XmlSerializer

setOutput

public void setOutput(java.io.Writer writer)
Description copied from interface: XmlSerializer
Set the output to the given writer.

WARNING no information about encoding is available!

Specified by:
setOutput in interface XmlSerializer

setOutput

public void setOutput(java.io.OutputStream out,
                      java.lang.String encoding)
               throws java.io.IOException
Description copied from interface: XmlSerializer
Set to use binary output stream with given encoding.

Specified by:
setOutput in interface XmlSerializer
Throws:
java.io.IOException

setPrefix

public void setPrefix(java.lang.String prefix,
                      java.lang.String nsp)
Description copied from interface: XmlSerializer
Binds 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 declaring 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.

Specified by:
setPrefix in interface XmlSerializer
Parameters:
prefix - must be not null (or IllegalArgumentException is thrown)
nsp - must be not null

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
Description copied from interface: XmlSerializer
Set the value of a property. (the property name is recommened 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 recocgnized or can not be set then IllegalStateException MUST be thrown.

Specified by:
setProperty in interface XmlSerializer

startDocument

public void startDocument(java.lang.String s,
                          java.lang.Boolean b)
                   throws java.io.IOException
Description copied from interface: XmlSerializer
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.

Specified by:
startDocument in interface XmlSerializer
Throws:
java.io.IOException

startTag

public XmlSerializer startTag(java.lang.String namespace,
                              java.lang.String name)
                       throws java.io.IOException
Description copied from interface: XmlSerializer
Writes 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 serialzier 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:
startTag in interface XmlSerializer
Throws:
java.io.IOException

text

public XmlSerializer text(char[] chars,
                          int start,
                          int len)
                   throws java.io.IOException
Description copied from interface: XmlSerializer
Writes text, where special XML chars are escaped automatically

Specified by:
text in interface XmlSerializer
Throws:
java.io.IOException

text

public XmlSerializer text(java.lang.String text)
                   throws java.io.IOException
Description copied from interface: XmlSerializer
Writes text, where special XML chars are escaped automatically

Specified by:
text in interface XmlSerializer
Throws:
java.io.IOException

endTag

public XmlSerializer endTag(java.lang.String namespace,
                            java.lang.String name)
                     throws java.io.IOException
Description copied from interface: XmlSerializer
Write 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 serialzier will make sure that default empty namespace is declared (in XML 1.0 xmlns='').

Specified by:
endTag in interface XmlSerializer
Throws:
java.io.IOException

writeLegacy

public void writeLegacy(int type,
                        java.lang.String data)
currently ignored!


writeInt

static void writeInt(java.io.OutputStream out,
                     int i)
              throws java.io.IOException
Throws:
java.io.IOException

writeStrI

static void writeStrI(java.io.OutputStream out,
                      java.lang.String s)
               throws java.io.IOException
Throws:
java.io.IOException

writeStrT

void writeStrT(java.lang.String s)
         throws java.io.IOException
Throws:
java.io.IOException

setTagTable

public void setTagTable(int page,
                        java.lang.String[] tagTable)
Sets the tag table for a given page. The first string in the array defines tag 5, the second tag 6 etc.


setAttrStartTable

public void setAttrStartTable(int page,
                              java.lang.String[] attrStartTable)
Sets the attribute start Table for a given page. The first string in the array defines attribute 5, the second attribute 6 etc. Please use the character '=' (without quote!) as delimiter between the attribute name and the (start of the) value


setAttrValueTable

public void setAttrValueTable(int page,
                              java.lang.String[] attrValueTable)
Sets the attribute value Table for a given page. The first string in the array defines attribute value 0x85, the second attribute value 0x86 etc.