org.apache.xerces.impl

Interface XMLEntityHandler

All Known Implementing Classes:

XML11DocumentScannerImpl, XML11DTDScannerImpl, XML11NSDocumentScannerImpl, XMLDocumentFragmentScannerImpl, XMLDocumentScannerImpl, XMLDTDScannerImpl, XMLNSDocumentScannerImpl

public interface XMLEntityHandler

The entity handler interface defines methods to report information about the start and end of entities.

Version:

$Id$

Author:

Andy Clark, IBM

See Also:

XMLEntityScanner

Method Summary

Modifier and Type	Method and Description
void	endEntity(String name, Augmentations augs) This method notifies the end of an entity.
void	startEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) This method notifies of the start of an entity.

Method Detail

startEntity

void startEntity(String name,
                 XMLResourceIdentifier identifier,
                 String encoding,
                 Augmentations augs)
          throws XNIException

This method notifies of the start of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters:

name - The name of the entity.

identifier - The resource identifier.

encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endEntity

void endEntity(String name,
               Augmentations augs)
        throws XNIException

This method notifies the end of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters:

name - The name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.