Google

Xerces 3.1.1 API: Interface LexicalHandler
Xerces 3.1.1


Interface LexicalHandler


public interface LexicalHandler

SAX2 extension handler for lexical events.

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

This is an optional extension handler for SAX2 to provide lexical information about an XML document, such as comments and CDATA section boundaries; XML readers are not required to support this handler.

The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events must appear between the content handler's startDocument and endDocument events.

To set the LexicalHandler for an XML reader, use the If the reader does not support lexical events, it will throw a or a when you attempt to register the handler.

Since:
SAX 2.0
Version:
2.0beta

int start, int length)
          Report an XML comment anywhere in the document.
          Report the end of a CDATA section.
          Report the end of DTD declarations.
          Report the end of an entity.
          Report the start of a CDATA section. java.lang.String publicId, java.lang.String systemId)
          Report the start of DTD declarations, if any.
          Report the beginning of an entity in content.
Method Summary
 void
 void
 void
 void
 void
 void
 void
 

Method Detail

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)
Report the start of DTD declarations, if any.

Any declarations are assumed to be in the internal subset event.

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

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

endDTD

public void endDTD()
Report the end of DTD declarations.

startEntity

public void startEntity(java.lang.String name)
Report the beginning of an entity in content.

NOTE: entity references in attribute values -- and the start and end of the document entity -- are never reported.

The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.

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

Parameters:
name - The name of the entity. If it is a parameter

endEntity

public void endEntity(java.lang.String name)
Report the end of an entity.

startCDATA

public void startCDATA()
Report the start of a CDATA section.

The contents of the CDATA section will be reported through


endCDATA

public void endCDATA()
Report the end of a CDATA section.

comment

public void comment(char[] ch,
                    int start,
                    int length)
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).


Xerces 3.1.1