org.apache.xerces.impl

Interface XMLEntityHandler

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: XMLEntityHandler.java,v 1.7 2003/05/08 20:11:54 elena Exp $

Author:
Andy Clark, IBM

See Also:
XMLEntityScanner

Method Summary

void
endEntity(String name)
This method notifies the end of an entity.
void
startEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding)
This method notifies of the start of an entity.

Method Details

endEntity

public void endEntity(String name)
            throws org.apache.xerces.xni.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.

Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.


startEntity

public void startEntity(String name,
                        org.apache.xerces.xni.XMLResourceIdentifier identifier,
                        String encoding)
            throws org.apache.xerces.xni.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).

Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.


Copyright B) 1999-2004 Apache XML Project. All Rights Reserved.