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

All Known Implementing Classes:

WBXMLWriter, XMLWriter

public interface RIMExtendedHandler

suppliment to org.xml.sax.helpers.DefaultHandler a RIM SAX parser will detect if the DefaultHandler implements this interface and make addition callbacks if it does

Since:

JDE 4.0.0

Method Summary

void	cdataSection(char[] text, int offset, int length) Receive notification of a CDATA section.
void	comment(char[] text, int offset, int length) Receive notification of a comment
void	defaultAttribute(String element, String attribute, String defaultValue) Receive notification of a default attribute value declaration
void	endDTD(String name, String publicId, String systemId, String body) Receive notification of the end of the document type definition
void	endEntityReference(String name) Receive notification of the end of an entity reference
void	entityDecl(String name, String value) Receive notification of a general entity declaration
void	startAndEndElement(String uri, String localName, String qName, Attributes attributes) Receive notification of the start and end of an element.
void	startDTD() Receive notification of the start of the document type definition
void	startEntityReference(String name, String publicId, String systemId) Receive notification of the start of an entity reference

Method Detail

startDTD

public void startDTD()
              throws SAXException

Receive notification of the start of the document type definition

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

endDTD

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

Receive notification of the end of the document type definition

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 - of the DTD. This includes all characters between

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

comment

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

Receive 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 - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

cdataSection

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

Receive 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 - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

startEntityReference

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

Receive 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:

JDE 4.0.0

endEntityReference

public void endEntityReference(String name)
                        throws SAXException

Receive notification of the end of an entity reference

Parameters:

name - The name of the entity

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

entityDecl

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

Receive notification of a general entity declaration

Parameters:

name - The name of the entity

value - The entity's replacement text

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

defaultAttribute

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

Receive 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 - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

startAndEndElement

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

Receive 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 - Any SAX exception, possibly wrapping another exception.

Since:

JDE 4.0.0

See Also:

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