com.sun.xml.bind.v2.runtime.output
Class FastInfosetStreamWriterOutput

java.lang.Object
  extended by com.sun.xml.bind.v2.runtime.output.XmlOutputAbstractImpl
      extended by com.sun.xml.bind.v2.runtime.output.XMLStreamWriterOutput
          extended by com.sun.xml.bind.v2.runtime.output.FastInfosetStreamWriterOutput
All Implemented Interfaces:
XmlOutput

public final class FastInfosetStreamWriterOutput
extends XMLStreamWriterOutput

XmlOutput for LowLevelStAXDocumentSerializer.

This class is responsible for managing the indexing of elements, attributes and local names that are known to JAXB by way of the JAXBContext (generated from JAXB beans or schema). The pre-encoded UTF-8 representations of known local names are also utilized.

The lookup of elements, attributes and local names with respect to a context is very efficient. It relies on an incrementing base line so that look up is performed in O(1) time and only uses static memory. When the base line reaches a point where integer overflow will occur the arrays and base line are reset (such an event is rare and will have little impact on performance).

A weak map of JAXB contexts to optimized tables for attributes, elements and local names is utilized and stored on the LowLevel StAX serializer. Thus, optimized serializing can work other multiple serializing of JAXB beans using the same LowLevel StAX serializer instance. This approach works best when JAXB contexts are only created once per schema or JAXB beans (which is the recommended practice as the creation JAXB contexts are expensive, they are thread safe and can be reused).


Field Summary
 
Fields inherited from class com.sun.xml.bind.v2.runtime.output.XMLStreamWriterOutput
buf
 
Fields inherited from class com.sun.xml.bind.v2.runtime.output.XmlOutputAbstractImpl
nsContext, nsUriIndex2prefixIndex, serializer
 
Constructor Summary
FastInfosetStreamWriterOutput(com.sun.xml.fastinfoset.stax.StAXDocumentSerializer out, JAXBContextImpl context)
           
 
Method Summary
 void attribute(int prefix, java.lang.String localName, java.lang.String value)
           
 void attribute(Name name, java.lang.String value)
           
 void beginStartTag(int prefix, java.lang.String localName)
           
 void beginStartTag(Name name)
          Writes a start tag.
 void beginStartTagWithNamespaces(Name name)
           
 void endDocument(boolean fragment)
          Called at the very end.
 void endStartTag()
           
 void endTag(int prefix, java.lang.String localName)
           
 void endTag(Name name)
           
 void startDocument(XMLSerializer serializer, boolean fragment, int[] nsUriIndex2prefixIndex, NamespaceContextImpl nsContext)
          Called at the very beginning.
 void text(Pcdata value, boolean needsSeparatingWhitespace)
          Writes XML text with character escaping, if necessary.
 void text(java.lang.String value, boolean needsSeparatingWhitespace)
          Writes XML text with character escaping, if necessary.
 
Methods inherited from class com.sun.xml.bind.v2.runtime.output.XMLStreamWriterOutput
create
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FastInfosetStreamWriterOutput

public FastInfosetStreamWriterOutput(com.sun.xml.fastinfoset.stax.StAXDocumentSerializer out,
                                     JAXBContextImpl context)
Method Detail

startDocument

public void startDocument(XMLSerializer serializer,
                          boolean fragment,
                          int[] nsUriIndex2prefixIndex,
                          NamespaceContextImpl nsContext)
                   throws java.io.IOException,
                          org.xml.sax.SAXException,
                          javax.xml.stream.XMLStreamException
Description copied from class: XmlOutputAbstractImpl
Called at the very beginning.

Specified by:
startDocument in interface XmlOutput
Overrides:
startDocument in class XMLStreamWriterOutput
Parameters:
serializer - the XMLSerializer that coordinates this whole marshalling episode.
fragment - true if we are marshalling a fragment.
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException

endDocument

public void endDocument(boolean fragment)
                 throws java.io.IOException,
                        org.xml.sax.SAXException,
                        javax.xml.stream.XMLStreamException
Description copied from class: XmlOutputAbstractImpl
Called at the very end.

Specified by:
endDocument in interface XmlOutput
Overrides:
endDocument in class XMLStreamWriterOutput
Parameters:
fragment - false if we are writing the whole document.
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException

beginStartTag

public void beginStartTag(Name name)
                   throws java.io.IOException
Description copied from class: XmlOutputAbstractImpl
Writes a start tag.

At this point XmlOutputAbstractImpl.nsContext holds namespace declarations needed for this new element.

This method is used for writing tags that are indexed.

Specified by:
beginStartTag in interface XmlOutput
Overrides:
beginStartTag in class XmlOutputAbstractImpl
Throws:
java.io.IOException

beginStartTagWithNamespaces

public void beginStartTagWithNamespaces(Name name)
                                 throws java.io.IOException
Throws:
java.io.IOException

attribute

public void attribute(Name name,
                      java.lang.String value)
               throws java.io.IOException
Specified by:
attribute in interface XmlOutput
Overrides:
attribute in class XmlOutputAbstractImpl
Throws:
java.io.IOException

endStartTag

public void endStartTag()
                 throws java.io.IOException
Specified by:
endStartTag in interface XmlOutput
Overrides:
endStartTag in class XMLStreamWriterOutput
Throws:
java.io.IOException

endTag

public void endTag(Name name)
            throws java.io.IOException
Specified by:
endTag in interface XmlOutput
Overrides:
endTag in class XmlOutputAbstractImpl
Throws:
java.io.IOException

endTag

public void endTag(int prefix,
                   java.lang.String localName)
            throws java.io.IOException
Specified by:
endTag in interface XmlOutput
Overrides:
endTag in class XMLStreamWriterOutput
Throws:
java.io.IOException

text

public void text(Pcdata value,
                 boolean needsSeparatingWhitespace)
          throws java.io.IOException
Description copied from interface: XmlOutput
Writes XML text with character escaping, if necessary.

Specified by:
text in interface XmlOutput
Overrides:
text in class XMLStreamWriterOutput
Parameters:
value - this string can contain characters that might need escaping (such as '&' or '>')
Throws:
java.io.IOException

text

public void text(java.lang.String value,
                 boolean needsSeparatingWhitespace)
          throws java.io.IOException
Description copied from interface: XmlOutput
Writes XML text with character escaping, if necessary.

Specified by:
text in interface XmlOutput
Overrides:
text in class XMLStreamWriterOutput
Parameters:
value - this string can contain characters that might need escaping (such as '&' or '>')
Throws:
java.io.IOException

beginStartTag

public void beginStartTag(int prefix,
                          java.lang.String localName)
                   throws java.io.IOException
Specified by:
beginStartTag in interface XmlOutput
Overrides:
beginStartTag in class XMLStreamWriterOutput
Throws:
java.io.IOException

attribute

public void attribute(int prefix,
                      java.lang.String localName,
                      java.lang.String value)
               throws java.io.IOException
Specified by:
attribute in interface XmlOutput
Overrides:
attribute in class XMLStreamWriterOutput
Parameters:
prefix - -1 if this attribute does not have a prefix (this handling differs from that of elements.)
Throws:
java.io.IOException