net.n3.nanoxml

Class XMLEntityResolver

Implemented Interfaces:
IXMLEntityResolver
Known Direct Subclasses:
SAXEntityResolver

public class XMLEntityResolver
extends Object
implements IXMLEntityResolver

An XMLEntityResolver resolves entities.
Version:
$Name: RELEASE_2_2_1 $, $Revision: 1.4 $
Author:
Marc De Scheemaecker

Constructor Summary

XMLEntityResolver()
Initializes the resolver.

Method Summary

void
addExternalEntity(String name, String publicID, String systemID)
Adds an external entity.
void
addInternalEntity(String name, String value)
Adds an internal entity.
protected void
finalize()
Cleans up the object when it's destroyed.
Reader
getEntity(IXMLReader xmlReader, String name)
Returns a Java reader containing the value of an entity.
boolean
isExternalEntity(String name)
Returns true if an entity is external.
protected Reader
openExternalEntity(IXMLReader xmlReader, String publicID, String systemID)
Opens an external entity.

Constructor Details

XMLEntityResolver

public XMLEntityResolver()
Initializes the resolver.

Method Details

addExternalEntity

public void addExternalEntity(String name,
                              String publicID,
                              String systemID)
Adds an external entity.
Specified by:
addExternalEntity in interface IXMLEntityResolver
Parameters:
name - the name of the entity.
publicID - the public ID of the entity, which may be null.
systemID - the system ID of the entity.

addInternalEntity

public void addInternalEntity(String name,
                              String value)
Adds an internal entity.
Specified by:
addInternalEntity in interface IXMLEntityResolver
Parameters:
name - the name of the entity.
value - the value of the entity.

finalize

protected void finalize()
            throws Throwable
Cleans up the object when it's destroyed.

getEntity

public Reader getEntity(IXMLReader xmlReader,
                        String name)
            throws XMLParseException
Returns a Java reader containing the value of an entity.
Specified by:
getEntity in interface IXMLEntityResolver
Parameters:
xmlReader - the current XML reader
name - the name of the entity.
Returns:
the reader, or null if the entity could not be resolved.

isExternalEntity

public boolean isExternalEntity(String name)
Returns true if an entity is external.
Specified by:
isExternalEntity in interface IXMLEntityResolver
Parameters:
name - the name of the entity.

openExternalEntity

protected Reader openExternalEntity(IXMLReader xmlReader,
                                    String publicID,
                                    String systemID)
            throws XMLParseException
Opens an external entity.
Parameters:
xmlReader - the current XML reader
publicID - the public ID, which may be null
systemID - the system ID
Returns:
the reader, or null if the reader could not be created/opened