net.rim.device.api.xml.jaxp
Class XMLWriter

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      net.rim.device.api.xml.jaxp.XMLWriter

All Implemented Interfaces:

RIMExtendedHandler, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XMLWriter
extends DefaultHandler
implements RIMExtendedHandler

This class implements an XML writer as a SAX parser handler. The writer can be passed to any parser and will write XML to the specified OutputStream. For example, an XML pretty-printer can be written as follows:

 XMLWriter writer = new XMLWriter( outStream );
 writer.setPrettyPrint();
 SAXParser parser = SAXParserFactory.newInstance().newSAXParser();
 parser.parse( inputStream, writer );
 

Since:

BlackBerry API 4.0.0

Constructor Summary

XMLWriter(OutputStream out)
Creates an XMLWriter.

Method Summary
void	cdataSection(char[] text, int offset, int length) Receives notification of a CDATA section.
void	characters(char[] ch, int start, int length) Receive notification of character data inside an element.
void	comment(char[] text, int offset, int length) Receives notification of a comment.
void	defaultAttribute(String element, String attribute, String defaultValue) Receives notification of a default attribute value declaration.
void	endDTD(String name, String publicId, String systemId, String body) Receives notification of the end of the document type definition (DTD).
void	endDocument() Receive notification of the end of the document.
void	endElement(String uri, String localName, String qName) Receive notification of the end of an element.
void	endEntityReference(String name) Receives notification of the end of an entity reference.
void	entityDecl(String name, String value) Receives notification of a general entity declaration.
void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
InputSource	resolveEntity(String publicId, String systemId) Resolve an external entity.
void	setEntityResolver(EntityResolver entityResolver) Sets the entity resolver for this writer.
void	setExpandingEntities(boolean expand) Indicates whether this writer should expand entities or print them as entity references, such as &ent;.
void	setPreserveSpacing() Configure this writer to print XML as close to the original as possible.
void	setPrettyPrint() Configures this writer to pretty-print the XML.
void	setPrintCompressedOutput() Configures this writer to print XML with no unnecessary whitespace.
void	startAndEndElement(String uri, String localName, String qName, Attributes attributes) Receives notification of the start and end of an element.
void	startDTD() Receives notification of the start of the document type definition (DTD).
void	startDocument() Receive notification of the beginning of the document.
void	startElement(String eUri, String localName, String qName, Attributes attributes) Receive notification of the start of an element.
void	startEntityReference(String name, String publicId, String systemId) Receives notification of the start of an entity reference.
void	startPrefixMapping(String prefix, String uri) Receive notification of the start of a Namespace mapping.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, notationDecl, setDocumentLocator, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLWriter

public XMLWriter(OutputStream out)

Creates an XMLWriter.

Parameters:

out - A stream to receive the XML output.

Since:

BlackBerry API 4.0.0

Method Detail

setPrettyPrint

public void setPrettyPrint()

Configures this writer to pretty-print the XML.

Since:

BlackBerry API 4.0.0

setPrintCompressedOutput

public void setPrintCompressedOutput()

Configures this writer to print XML with no unnecessary whitespace.

Since:

BlackBerry API 4.0.0

setPreserveSpacing

public void setPreserveSpacing()

Configure this writer to print XML as close to the original as possible.

Note: This is the default.

Since:

BlackBerry API 4.0.0

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)

Sets the entity resolver for this writer. If the parser encounters external parsed entities, it asks the writer to resolve them.

Parameters:

entityResolver - The entity resolver.

Since:

BlackBerry API 4.0.0

setExpandingEntities

public void setExpandingEntities(boolean expand)

Indicates whether this writer should expand entities or print them as entity references, such as &ent;.

Parameters:

expand - true to expand entities; false otherwise.

Since:

BlackBerry API 4.0.0

startDTD

public void startDTD()

Description copied from interface: RIMExtendedHandler

Receives notification of the start of the document type definition (DTD).

Specified by:

startDTD in interface RIMExtendedHandler

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

endDTD

public void endDTD(String name,
                   String publicId,
                   String systemId,
                   String body)
            throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of the end of the document type definition (DTD).

Specified by:

endDTD in interface RIMExtendedHandler

Parameters:

name - The document name.

publicId - The public ID of the DTD external subset (or null).

systemId - The sytem ID of the DTD external subset (or null of no external subset specified).

body - The body of the DTD. This includes all characters between .

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

comment

public void comment(char[] text,
                    int offset,
                    int length)
             throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of a comment.

Specified by:

comment in interface RIMExtendedHandler

Parameters:

text - The comment characters not including .

offset - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

cdataSection

public void cdataSection(char[] text,
                         int offset,
                         int length)
                  throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of a CDATA section.

Specified by:

cdataSection in interface RIMExtendedHandler

Parameters:

text - The CDATA characters not including .

offset - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

startEntityReference

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

Description copied from interface: RIMExtendedHandler

Receives notification of the start of an entity reference.

Specified by:

startEntityReference in interface RIMExtendedHandler

Parameters:

name - The name of the entity.

publicId - The public ID of the entity.

systemId - The system ID of the entity or null if this is an internal entity

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

endEntityReference

public void endEntityReference(String name)
                        throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of the end of an entity reference.

Specified by:

endEntityReference in interface RIMExtendedHandler

Parameters:

name - The name of the entity.

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

entityDecl

public void entityDecl(String name,
                       String value)
                throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of a general entity declaration.

Specified by:

entityDecl in interface RIMExtendedHandler

Parameters:

name - The name of the entity.

value - The entity's replacement text.

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

defaultAttribute

public void defaultAttribute(String element,
                             String attribute,
                             String defaultValue)
                      throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of a default attribute value declaration.

Specified by:

defaultAttribute in interface RIMExtendedHandler

Parameters:

element - The qualified name of the element.

attribute - The qualified name of the attribute.

defaultValue - The default attribute value.

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

characters

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

Description copied from class: DefaultHandler

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).

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Parameters:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

ignorableWhitespace

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

Description copied from class: DefaultHandler

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).

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Parameters:

ch - The whitespace characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

processingInstruction

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

Description copied from class: DefaultHandler

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.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Parameters:

target - The processing instruction target.

data - The processing instruction data, or null if none is supplied.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

startDocument

public void startDocument()
                   throws SAXException

Description copied from class: DefaultHandler

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).

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

endDocument

public void endDocument()
                 throws SAXException

Description copied from class: DefaultHandler

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).

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

startAndEndElement

public void startAndEndElement(String uri,
                               String localName,
                               String qName,
                               Attributes attributes)
                        throws SAXException

Description copied from interface: RIMExtendedHandler

Receives notification of the start and end of an element. The element contains no content.

Specified by:

startAndEndElement in interface RIMExtendedHandler

attributes - The specified or defaulted attributes.

Throws:

SAXException - Thrown if a SAX exception, possibly wrapping another exception, occurs.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

startElement

public void startElement(String eUri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

Description copied from class: DefaultHandler

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).

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

eUri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

attributes - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

endElement

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

Description copied from class: DefaultHandler

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).

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

startPrefixMapping

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

Description copied from class: DefaultHandler

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).

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI mapped to the prefix.

Throws:

SAXException - the client may throw an exception during processing

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException

Description copied from class: DefaultHandler

Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Parameters:

publicId - The public identifer, or null if none is available.

systemId - The system identifier provided in the XML document.

Returns:

The new input source, or null to require the default behaviour.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.

See Also:

This method is only public for implementation reasons. Do not use or override.

Since:

BlackBerry API 4.0.0