org.xml.sax.ext
Class DefaultHandler2

java.lang.Object   
  org.xml.sax.helpers.DefaultHandler   
      org.xml.sax.ext.DefaultHandler2

All Implemented Interfaces:

ContentHandler , DTDHandler , EntityResolver , ErrorHandler , DeclHandler , EntityResolver2 , LexicalHandler

public class DefaultHandler2
extends DefaultHandler   
implements LexicalHandler   , DeclHandler   , EntityResolver2   

This class extends the SAX2 base handler class to support the SAX2 LexicalHandler , DeclHandler , and EntityResolver2 extensions. Except for overriding the original SAX1 resolveEntity() method the added handler methods just return. Subclassers may override everything on a method-by-method basis.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

Note: this class might yet learn that the ContentHandler.setDocumentLocator() call might be passed a Locator2 object, and that the ContentHandler.startElement() call might be passed a Attributes2 object.

Since:

SAX 2.0 (extensions 1.1 alpha)

Constructor Summary

DefaultHandler2 ()
Constructs a handler which ignores all parsing events.

Method Summary

void	attributeDecl (String eName, String aName, String type, String mode, String value) Report an attribute type declaration.
void	comment (char[] ch, int start, int length) Report an XML comment anywhere in the document.
void	elementDecl (String name, String model) Report an element type declaration.
void	endCDATA () Report the end of a CDATA section.
void	endDTD () Report the end of DTD declarations.
void	endEntity (String name) Report the end of an entity.
void	externalEntityDecl (String name, String publicId, String systemId) Report a parsed external entity declaration.
InputSource	getExternalSubset (String name, String baseURI) Tells the parser that if no external subset has been declared in the document text, none should be used.
void	internalEntityDecl (String name, String value) Report an internal entity declaration.
InputSource	resolveEntity (String publicId, String systemId) Invokes EntityResolver2.resolveEntity() with null entity name and base URI.
InputSource	resolveEntity (String name, String publicId, String baseURI, String systemId) Tells the parser to resolve the systemId against the baseURI and read the entity text from that resulting absolute URI.
void	startCDATA () Report the start of a CDATA section.
void	startDTD (String name, String publicId, String systemId) Report the start of DTD declarations, if any.
void	startEntity (String name) Report the beginning of some internal and external XML entities.

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

characters , endDocument , endElement , endPrefixMapping , error , fatalError , ignorableWhitespace , notationDecl , processingInstruction , setDocumentLocator , skippedEntity , startDocument , startElement , startPrefixMapping , unparsedEntityDecl , warning

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHandler2

public DefaultHandler2()

Constructs a handler which ignores all parsing events.

Method Detail

startCDATA

public void startCDATA()
                throws SAXException   

Description copied from interface: LexicalHandler

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.

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endCDATA()

endCDATA

public void endCDATA()
              throws SAXException   

Description copied from interface: LexicalHandler

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startCDATA()

startDTD

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

Description copied from interface: LexicalHandler

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.

Specified by:

startDTD in interface LexicalHandler

Parameters:

name - The document type name.

publicId - The declared public identifier for the external DTD subset, or null if none was declared.

systemId - The declared system identifier for the external DTD subset, or null if none was declared. (Note that this is not resolved against the document base URI.)

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endDTD() , LexicalHandler.startEntity(java.lang.String)

endDTD

public void endDTD()
            throws SAXException   

Description copied from interface: LexicalHandler

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.

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)

startEntity

public void startEntity(String    name)
                 throws SAXException   

Description copied from interface: LexicalHandler

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.

Specified by:

startEntity in interface LexicalHandler

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endEntity(java.lang.String) , DeclHandler.internalEntityDecl(java.lang.String, java.lang.String) , DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)

endEntity

public void endEntity(String    name)
               throws SAXException   

Description copied from interface: LexicalHandler

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startEntity(java.lang.String)

comment

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

Description copied from interface: LexicalHandler