File	Doc	Category	Size	Date	Package
LexicalHandler.java	API Doc	Java SE 5 API	8026	Fri Aug 26 14:58:42 BST 2005	org.xml.sax.ext

LexicalHandler

Fields Summary

Constructors Summary

Methods Summary
public abstract 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). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used). param ch An array holding the characters in the comment. param start The starting position in the array. param length The number of characters to use from the array. exception SAXException The application may raise an exception.
public abstract void	endCDATA() Report the end of a CDATA section. exception SAXException The application may raise an exception. see #startCDATA
public abstract void	endDTD() 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. exception SAXException The application may raise an exception. see #startDTD
public abstract void	endEntity(java.lang.String name) Report the end of an entity. param name The name of the entity that is ending. exception SAXException The application may raise an exception. see #startEntity
public abstract void	startCDATA() Report the start of a CDATA section. The contents of the CDATA section will be reported through the regular {@link org.xml.sax.ContentHandler#characters characters} event; this event is intended only to report the boundary. exception SAXException The application may raise an exception. see #endCDATA
public abstract void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) 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 {@link org.xml.sax.DTDHandler DTDHandler} or {@link org.xml.sax.ext.DeclHandler DeclHandler} events must appear between the startDTD and {@link #endDTD endDTD} events. Declarations are assumed to belong to the internal DTD subset unless they appear between {@link #startEntity startEntity} and {@link #endEntity 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 {@link org.xml.sax.ContentHandler#startElement startElement} event. param name The document type name. param publicId The declared public identifier for the external DTD subset, or null if none was declared. param 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.) exception SAXException The application may raise an exception. see #endDTD see #startEntity
public abstract void	startEntity(java.lang.String name) 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 {@link org.xml.sax.ext.DeclHandler DeclHandler} or {@link org.xml.sax.DTDHandler DTDHandler} be properly ordered. Note that skipped entities will be reported through the {@link org.xml.sax.ContentHandler#skippedEntity 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. param 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]". exception SAXException The application may raise an exception. see #endEntity see org.xml.sax.ext.DeclHandler#internalEntityDecl see org.xml.sax.ext.DeclHandler#externalEntityDecl