org.apache.xerces.impl
Interface XMLEntityHandler

All Known Implementing Classes:
XMLDocumentFragmentScannerImpl, XMLDTDScannerImpl

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.2 2001/08/23 00:35:21 lehors Exp $
Author:
Stubs generated by DesignDoc on Mon Sep 18 18:23:16 PDT 2000, Andy Clark, IBM
See Also:
XMLEntityScanner

Method Summary
 void endEntity(java.lang.String name)
          This method notifies the end of an entity.
 void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding)
          This method notifies of the start of an entity.
 

Method Detail

startEntity

public void startEntity(java.lang.String name,
                        java.lang.String publicId,
                        java.lang.String systemId,
                        java.lang.String baseSystemId,
                        java.lang.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.
publicId - The public identifier of the entity if the entity is external, null otherwise.
systemId - The system identifier of the entity if the entity is external, null otherwise.
baseSystemId - The base system identifier of the entity if the entity is external, null otherwise.
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.

endEntity

public void endEntity(java.lang.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.


Copyright © 1999-2001 Apache XML Project. All Rights Reserved.