net.rim.device.api.xml.jaxp
Interface RIMExtendedHandler

All Known Implementing Classes:

WBXMLWriter, XMLWriter

public interface RIMExtendedHandler

A supplement to org.xml.sax.helpers.DefaultHandler. A RIM SAX parser detects if the DefaultHandler implements this interface and makes addition callbacks if it does.

Since:

BlackBerry API 4.0.0

Method Summary
void	cdataSection(char[] text, int offset, int length) Receives notification of a CDATA section.
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	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	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	startEntityReference(String name, String publicId, String systemId) Receives notification of the start of an entity reference.

Method Detail

startDTD

void startDTD()
              throws SAXException

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

Throws:

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

Since:

BlackBerry API 4.0.0

endDTD

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

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

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.

Since:

BlackBerry API 4.0.0

comment

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

Receives notification of a comment.

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.

Since:

BlackBerry API 4.0.0

cdataSection

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

Receives notification of a CDATA section.

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.

Since:

BlackBerry API 4.0.0

startEntityReference

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

Receives notification of the start of an entity reference.

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.

Since:

BlackBerry API 4.0.0

endEntityReference

void endEntityReference(String name)
                        throws SAXException

Receives notification of the end of an entity reference.

Parameters:

name - The name of the entity.

Throws:

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

Since:

BlackBerry API 4.0.0

entityDecl

void entityDecl(String name,
                String value)
                throws SAXException

Receives notification of a general entity declaration.

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.

Since:

BlackBerry API 4.0.0

defaultAttribute

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

Receives notification of a default attribute value declaration.

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.

Since:

BlackBerry API 4.0.0

startAndEndElement

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

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

Parameters:

name - The element type name.

attributes - The specified or defaulted attributes.

Throws:

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

See Also:

org.xml.sax.helpers.DefaultHandler.startElement, org.xml.sax.helpers.DefaultHandler.endElement

Since:

BlackBerry API 4.0.0