JAXB OSGI 4.0.9 · com.sun.xml.fastinfoset.tools.SAX2StAXWriter

Modifier and Type	Field and Description
pack-priv ArrayList<QualifiedName>	_namespaces List of namespace decl for upcoming element.
pack-priv XMLStreamWriter	_writer XML stream writer where events are pushed.
private static final Logger	logger

Access	Constructor and Description
public	SAX2StAXWriter(XMLStreamWriter writer)

Method Summary

Modifier and Type	Method and Description
public void	characters(char[] ch, int start, int length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Receive notification of character data inside an element.
public void	comment(char[] ch, int start, int length) Implements org.xml.sax.ext.LexicalHandler.comment. Report an XML comment anywhere in the document.
public void	endCDATA() Implements org.xml.sax.ext.LexicalHandler.endCDATA. Report the end of a CDATA section.
public void	endDocument() Overrides org.xml.sax.helpers.DefaultHandler.endDocument. Implements org.xml.sax.ContentHandler.endDocument. Receive notification of the end of the document.
public void	endDTD() Implements org.xml.sax.ext.LexicalHandler.endDTD. Report the end of DTD declarations.
public void	endElement(String namespaceURI, String localName, String qName) Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element.
public void	endEntity(String name) Implements org.xml.sax.ext.LexicalHandler.endEntity. Report the end of an entity.
public XMLStreamWriter	getWriter()
public void	ignorableWhitespace(char[] ch, int start, int length) Overrides org.xml.sax.helpers.DefaultHandler.ignorableWhitespace. Implements org.xml.sax.ContentHandler.ignorableWhitespace. Receive notification of ignorable whitespace in element content.
public void	processingInstruction(String target, String data) Overrides org.xml.sax.helpers.DefaultHandler.processingInstruction. Implements org.xml.sax.ContentHandler.processingInstruction. Receive notification of a processing instruction.
public void	startCDATA() Implements org.xml.sax.ext.LexicalHandler.startCDATA. Report the start of a CDATA section.
public void	startDocument() Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Receive notification of the beginning of the document.
public void	startDTD(String name, String publicId, String systemId) Implements org.xml.sax.ext.LexicalHandler.startDTD. Report the start of DTD declarations, if any.
public void	startElement(String namespaceURI, String localName, String qName, Attributes atts) Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Receive notification of the start of an element.
public void	startEntity(String name) Implements org.xml.sax.ext.LexicalHandler.startEntity. Report the beginning of some internal and external XML entities.
public void	startPrefixMapping(String prefix, String uri) Overrides org.xml.sax.helpers.DefaultHandler.startPrefixMapping. Implements org.xml.sax.ContentHandler.startPrefixMapping. Receive notification of the start of a Namespace mapping.

Inherited from org.xml.sax.helpers.DefaultHandler:: endPrefixMapping error fatalError notationDecl resolveEntity setDocumentLocator skippedEntity unparsedEntityDecl warning

_namespaces	back to summary
pack-priv ArrayList<QualifiedName> _namespaces List of namespace decl for upcoming element.

_writer	back to summary
pack-priv XMLStreamWriter _writer XML stream writer where events are pushed.

logger	back to summary
private static final Logger logger

SAX2StAXWriter	back to summary
public SAX2StAXWriter(XMLStreamWriter writer)

Method Detail

characters	back to summary
public void characters(char[] ch, int start, int length) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Doc from org.xml.sax.helpers.DefaultHandler.characters. Receive notification of character data inside an element. By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

characters

back to summary

public void characters(char[] ch, int start, int length) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.characters.

Implements org.xml.sax.ContentHandler.characters.

Doc from org.xml.sax.helpers.DefaultHandler.characters.

Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

comment	back to summary
public void comment(char[] ch, int start, int length) throws SAXException Implements org.xml.sax.ext.LexicalHandler.comment. Doc from org.xml.sax.ext.LexicalHandler.comment. Report an XML comment anywhere in the document. This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used). Annotations @Override Exceptions SAXException: The application may raise an exception.

comment

back to summary

public void comment(char[] ch, int start, int length) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.comment.

Doc from org.xml.sax.ext.LexicalHandler.comment.

Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

endCDATA	back to summary
public void endCDATA() throws SAXException Implements org.xml.sax.ext.LexicalHandler.endCDATA. Doc from org.xml.sax.ext.LexicalHandler.endCDATA. Report the end of a CDATA section. Annotations @Override Exceptions SAXException: The application may raise an exception.

endCDATA

back to summary

public void endCDATA() throws SAXException

Implements org.xml.sax.ext.LexicalHandler.endCDATA.

Doc from org.xml.sax.ext.LexicalHandler.endCDATA.

Report the end of a CDATA section.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

endDocument	back to summary
public void endDocument() throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.endDocument. Implements org.xml.sax.ContentHandler.endDocument. Doc from org.xml.sax.helpers.DefaultHandler.endDocument. Receive notification of the end of the document. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endDocument

back to summary

public void endDocument() throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.endDocument.

Implements org.xml.sax.ContentHandler.endDocument.

Doc from org.xml.sax.helpers.DefaultHandler.endDocument.

Receive notification of the end of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

endDTD	back to summary
public void endDTD() throws SAXException Implements org.xml.sax.ext.LexicalHandler.endDTD. Doc from org.xml.sax.ext.LexicalHandler.endDTD. Report the end of DTD declarations. This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked. Annotations @Override Exceptions SAXException: The application may raise an exception.

endDTD

back to summary

public void endDTD() throws SAXException

Implements org.xml.sax.ext.LexicalHandler.endDTD.

Doc from org.xml.sax.ext.LexicalHandler.endDTD.

Report the end of DTD declarations.

This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

endElement	back to summary
public void endElement(String namespaceURI, String localName, String qName) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Doc from org.xml.sax.helpers.DefaultHandler.endElement. Receive notification of the end of an element. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endElement

back to summary

public void endElement(String namespaceURI, String localName, String qName) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.endElement.

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.helpers.DefaultHandler.endElement.

Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

endEntity	back to summary
public void endEntity(String name) throws SAXException Implements org.xml.sax.ext.LexicalHandler.endEntity. Doc from org.xml.sax.ext.LexicalHandler.endEntity. Report the end of an entity. Annotations @Override Exceptions SAXException: The application may raise an exception.

endEntity

back to summary

public void endEntity(String name) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.endEntity.

Doc from org.xml.sax.ext.LexicalHandler.endEntity.

Report the end of an entity.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

getWriter	back to summary
public XMLStreamWriter getWriter()

ignorableWhitespace	back to summary
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.ignorableWhitespace. Implements org.xml.sax.ContentHandler.ignorableWhitespace. Doc from org.xml.sax.helpers.DefaultHandler.ignorableWhitespace. Receive notification of ignorable whitespace in element content. By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

ignorableWhitespace

back to summary

public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.ignorableWhitespace.

Implements org.xml.sax.ContentHandler.ignorableWhitespace.

Doc from org.xml.sax.helpers.DefaultHandler.ignorableWhitespace.

Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

processingInstruction	back to summary
public void processingInstruction(String target, String data) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.processingInstruction. Implements org.xml.sax.ContentHandler.processingInstruction. Doc from org.xml.sax.helpers.DefaultHandler.processingInstruction. Receive notification of a processing instruction. By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

processingInstruction

back to summary

public void processingInstruction(String target, String data) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.processingInstruction.

Implements org.xml.sax.ContentHandler.processingInstruction.

Doc from org.xml.sax.helpers.DefaultHandler.processingInstruction.

Receive notification of a processing instruction.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

startCDATA back to summary

startCDATA	back to summary
public void startCDATA() throws SAXException Implements org.xml.sax.ext.LexicalHandler.startCDATA. Doc from org.xml.sax.ext.LexicalHandler.startCDATA. Report the start of a CDATA section. The contents of the CDATA section will be reported through the regular `characters` event; this event is intended only to report the boundary. Annotations @Override Exceptions SAXException: The application may raise an exception.

public void startCDATA() throws SAXException

Implements org.xml.sax.ext.LexicalHandler.startCDATA.

Doc from org.xml.sax.ext.LexicalHandler.startCDATA.

Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular characters event; this event is intended only to report the boundary.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

startDocument	back to summary
public void startDocument() throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Doc from org.xml.sax.helpers.DefaultHandler.startDocument. Receive notification of the beginning of the document. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

startDocument

back to summary

public void startDocument() throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startDocument.

Implements org.xml.sax.ContentHandler.startDocument.

Doc from org.xml.sax.helpers.DefaultHandler.startDocument.

Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

startDTD back to summary

startDTD	back to summary
public void startDTD(String name, String publicId, String systemId) throws SAXException Implements org.xml.sax.ext.LexicalHandler.startDTD. Doc from org.xml.sax.ext.LexicalHandler.startDTD. Report the start of DTD declarations, if any. This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked. All declarations reported through `DTDHandler` or `DeclHandler` events must appear between the startDTD and `endDTD` events. Declarations are assumed to belong to the internal DTD subset unless they appear between `startEntity` and `endEntity` events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however. Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first `startElement` event. Annotations @Override Exceptions SAXException: The application may raise an exception.

public void startDTD(String name, String publicId, String systemId) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.startDTD.

Doc from org.xml.sax.ext.LexicalHandler.startDTD.

Report the start of DTD declarations, if any.

This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

All declarations reported through DTDHandler or DeclHandler events must appear between the startDTD and endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity and endEntity events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement event.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

startElement	back to summary
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Doc from org.xml.sax.helpers.DefaultHandler.startElement. Receive notification of the start of an element. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

startElement

back to summary

public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startElement.

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.helpers.DefaultHandler.startElement.

Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

startEntity back to summary

startEntity	back to summary
public void startEntity(String name) throws SAXException Implements org.xml.sax.ext.LexicalHandler.startEntity. Doc from org.xml.sax.ext.LexicalHandler.startEntity. Report the beginning of some internal and external XML entities. The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the `http://xml.org/sax/features/lexical-handler/parameter-entities` feature to query or control the reporting of parameter entities. General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]". When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from `DeclHandler` or `DTDHandler` be properly ordered. Note that skipped entities will be reported through the `skippedEntity` event, which is part of the ContentHandler interface. Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances: general entities within attribute values parameter entities within declarations These will be silently expanded, with no indication of where the original entity boundaries were. Note also that the boundaries of character references (which are not really entities anyway) are not reported. All start/endEntity events must be properly nested. Annotations @Override Exceptions SAXException: The application may raise an exception.

public void startEntity(String name) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.startEntity.

Doc from org.xml.sax.ext.LexicalHandler.startEntity.

Report the beginning of some internal and external XML entities.

The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the http://xml.org/sax/features/lexical-handler/parameter-entities feature to query or control the reporting of parameter entities.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from DeclHandler or DTDHandler be properly ordered.

Note that skipped entities will be reported through the skippedEntity event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

general entities within attribute values
parameter entities within declarations

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

startPrefixMapping	back to summary
public void startPrefixMapping(String prefix, String uri) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startPrefixMapping. Implements org.xml.sax.ContentHandler.startPrefixMapping. Doc from org.xml.sax.helpers.DefaultHandler.startPrefixMapping. Receive notification of the start of a Namespace mapping. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

startPrefixMapping

back to summary

public void startPrefixMapping(String prefix, String uri) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startPrefixMapping.

Implements org.xml.sax.ContentHandler.startPrefixMapping.

Doc from org.xml.sax.helpers.DefaultHandler.startPrefixMapping.

Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

public Class SAX2StAXWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail