org.xml.sax.misc
Interface LexicalHandler

public interface LexicalHandler

Optional add-on SAX2 handler for lexical events. This handler type is optional: not all SAX parsers will support it. To set the LexicalHandler for a parser, use Configurable.setProperty with the propertyId "http://xml.org/sax/handlers/LexicalHandler".

See Also:

Configurable

Method Summary

void	comment(char[] ch, int start, int length) Report an XML comment anywhere in the document.
void	endCDATA() Report the end of a CDATA section.
void	endDTD() Report the end of DTD declarations.
void	endEntity(java.lang.String name) Report the end of an entity.
void	startCDATA() Report the start of a CDATA section.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Report the start of DTD declarations, if any.
void	startEntity(java.lang.String name) Report the beginning of an entity.

Method Detail

startDTD

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

Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.

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.

Throws:

SAXException - The application may raise an exception.

See Also:

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

endDTD

public void endDTD()
            throws SAXException

Report the end of DTD declarations.

Throws:

SAXException - The application may raise an exception.

See Also:

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

startEntity

public void startEntity(java.lang.String name)
                 throws SAXException

Report the beginning of an entity. The start and end of the document entity are not 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.

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException - The application may raise an exception.

See Also:

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(java.lang.String name)
               throws SAXException

Report the end of an entity.

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException - The application may raise an exception.

See Also:

startEntity(java.lang.String)

startCDATA

public void startCDATA()
                throws SAXException

Report the start of a CDATA section.

Throws:

SAXException - The application may raise an exception.

See Also:

endCDATA()

endCDATA

public void endCDATA()
              throws SAXException

Report the end of a CDATA section.

Throws:

SAXException - The application may raise an exception.

See Also:

startCDATA()

comment

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

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).

Parameters:

ch - An array holding the characters in the comment.

start - The starting position in the array.

length - The number of characters to use from the array.

Throws:

SAXException - The application may raise an exception.