OpenJDK 1.23 · org.xml.sax.ext.LexicalHandler · APIdia, the JavaDoc alternative

Modifier and Type	Method and Description
public void	comment(char[] An array holding the characters in the comment. ch, int The starting position in the array. start, int The number of characters to use from the array. length) Report an XML comment anywhere in the document.
public void	endCDATA() Report the end of a CDATA section.
public void	endDTD() Report the end of DTD declarations.
public void	endEntity(String The name of the entity that is ending. name) Report the end of an entity.
public void	startCDATA() Report the start of a CDATA section.
public void	startDTD(String The document type name. name, String The declared public identifier for the external DTD subset, or null if none was declared. publicId, String 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.) systemId) Report the start of DTD declarations, if any.
public void	startEntity(String 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]". name) Report the beginning of some internal and external XML entities.

Method Detail

comment	back to summary
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). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used). Parameters ch:char[] An array holding the characters in the comment. start:int The starting position in the array. length:int The number of characters to use from the array. Exceptions SAXException: The application may raise an exception.

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). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).

Parameters

ch:char[]: An array holding the characters in the comment.
start:int: The starting position in the array.
length:int: The number of characters to use from the array.

Exceptions

SAXException:: The application may raise an exception.

endCDATA back to summary

endCDATA	back to summary
public void endCDATA() throws SAXException Report the end of a CDATA section. Exceptions SAXException: The application may raise an exception. See Also `startCDATA`

public void endCDATA() throws SAXException

Report the end of a CDATA section.

Exceptions

SAXException:: The application may raise an exception.

See Also

startCDATA

endDTD back to summary

endDTD	back to summary
public void endDTD() throws SAXException 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. Exceptions SAXException: The application may raise an exception. See Also `startDTD`

public void endDTD() throws SAXException

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.

Exceptions

SAXException:: The application may raise an exception.

See Also

startDTD

endEntity back to summary

endEntity	back to summary
public void endEntity(String name) throws SAXException Report the end of an entity. Parameters name:String The name of the entity that is ending. Exceptions SAXException: The application may raise an exception. See Also `startEntity`

public void endEntity(String name) throws SAXException

Report the end of an entity.

Parameters

name:String: The name of the entity that is ending.

Exceptions

SAXException:: The application may raise an exception.

See Also

startEntity

startCDATA back to summary

startCDATA	back to summary
public void startCDATA() throws SAXException 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. Exceptions SAXException: The application may raise an exception. See Also `endCDATA`

public void startCDATA() throws SAXException

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.

Exceptions

SAXException:: The application may raise an exception.

See Also

endCDATA

startDTD back to summary

startDTD	back to summary
public void startDTD(String name, String publicId, String systemId) throws SAXException 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. Parameters name:String The document type name. publicId:String The declared public identifier for the external DTD subset, or null if none was declared. systemId:String 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.) Exceptions SAXException: The application may raise an exception. See Also `endDTD`, `startEntity`

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

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.

Parameters

name:String: The document type name.
publicId:String: The declared public identifier for the external DTD subset, or null if none was declared.
systemId:String: 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.)

Exceptions

SAXException:: The application may raise an exception.

See Also

endDTD, startEntity

startEntity back to summary

startEntity	back to summary
public void startEntity(String name) throws SAXException 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. Parameters name:String 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]". Exceptions SAXException: The application may raise an exception. See Also `endEntity`, `org.xml.sax.ext.DeclHandler#internalEntityDecl`, `org.xml.sax.ext.DeclHandler#externalEntityDecl`

public void startEntity(String name) throws SAXException

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.

Parameters

name:String: 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]".

Exceptions

SAXException:: The application may raise an exception.

public Interface LexicalHandler

Method Summary

Method Detail