XML for Java Compatibility API 2.0.13

com.ibm.xml.parser
Interface StreamProducer

All Known Implementing Classes:
SAXDriver, Stderr

public abstract interface StreamProducer

An interface to be implemented in order to define the mechanisms for manipulating input streams. Typical sources of input streams include character streams, a byte streams, or URIs.

Version:
Revision: 89 1.5 src/com/ibm/xml/parser/StreamProducer.java, parser, xml4j2, xml4j2_0_13

Method Summary
 void closeInputStream(Source source)
          Interface to be implemented in order to remove the input stream currently in use.
 Source getInputStream(java.lang.String name, java.lang.String publicID, java.lang.String systemID)
          Interface to be implemented in order to return the source of the input stream (could be a character stream, a byte stream, or a URI) based on the entity specified by the system ID and/or public ID.
 void loadCatalog(java.io.Reader reader)
          Loads a catalog which provides mapping between public IDs and system IDs.
 

Method Detail

getInputStream

public Source getInputStream(java.lang.String name,
                             java.lang.String publicID,
                             java.lang.String systemID)
                      throws java.io.IOException
Interface to be implemented in order to return the source of the input stream (could be a character stream, a byte stream, or a URI) based on the entity specified by the system ID and/or public ID.
Parameters:
name - The name to be associated with the input stream. For example, this name could be the public ID of an external ID, or a local filename.
publicID - Entity's public ID (see ExternalID for details).
systemID - Entity's system ID (see ExternalID for details).
Returns:
The resolved source of the input stream.
Throws:
java.io.IOException - Thrown if unable to resolve the source of the input stream.
See Also:
ExternalID, closeInputStream(com.ibm.xml.parser.Source), Parser.getInputStream(java.lang.String, java.lang.String, java.lang.String)

closeInputStream

public void closeInputStream(Source source)
Interface to be implemented in order to remove the input stream currently in use.
Parameters:
source - Source of the input stream to be closed.
See Also:
getInputStream(java.lang.String, java.lang.String, java.lang.String), Parser.getInputStream(java.lang.String, java.lang.String, java.lang.String)

loadCatalog

public void loadCatalog(java.io.Reader reader)
                 throws java.io.IOException
Loads a catalog which provides mapping between public IDs and system IDs.
Parameters:
reader - Character input stream reader.
Throws:
java.io.IOException - Thrown if reader is invalid.
See Also:
getInputStream(java.lang.String, java.lang.String, java.lang.String), ExternalID, Parser.loadCatalog(java.io.Reader), Stderr.loadCatalog(java.io.Reader)

XML for Java Compatibility API 2.0.13