Interface IXMLEntityResolver

  • All Known Implementing Classes:
    SAXEntityResolver, XMLEntityResolver

    public interface IXMLEntityResolver
    An IXMLEntityResolver resolves entities.
    Author:
    Marc De Scheemaecker
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addExternalEntity​(java.lang.String name, java.lang.String publicID, java.lang.String systemID)
      Adds an external entity.
      void addInternalEntity​(java.lang.String name, java.lang.String value)
      Adds an internal entity.
      java.io.Reader getEntity​(IXMLReader xmlReader, java.lang.String name)
      Returns a Java reader containing the value of an entity.
      boolean isExternalEntity​(java.lang.String name)
      Returns true if an entity is external.
    • Method Detail

      • addInternalEntity

        void addInternalEntity​(java.lang.String name,
                               java.lang.String value)
        Adds an internal entity.
        Parameters:
        name - the name of the entity.
        value - the value of the entity.
      • addExternalEntity

        void addExternalEntity​(java.lang.String name,
                               java.lang.String publicID,
                               java.lang.String systemID)
        Adds an external entity.
        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.
      • getEntity

        java.io.Reader getEntity​(IXMLReader xmlReader,
                                 java.lang.String name)
                          throws XMLParseException
        Returns a Java reader containing the value of an entity.
        Parameters:
        xmlReader - the current NanoXML reader.
        name - the name of the entity.
        Returns:
        the reader, or null if the entity could not be resolved.
        Throws:
        XMLParseException - If an exception occurred while resolving the entity.
      • isExternalEntity

        boolean isExternalEntity​(java.lang.String name)
        Returns true if an entity is external.
        Parameters:
        name - the name of the entity.