FileDocCategorySizeDatePackage
InputSource.javaAPI DocAndroid 1.5 API10266Wed May 06 22:41:06 BST 2009org.xml.sax

InputSource

public class InputSource extends Object
A single input source for an XML entity.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This class allows a SAX application to encapsulate information about an input source in a single object, which may include a public identifier, a system identifier, a byte stream (possibly with a specified encoding), and/or a character stream.

There are two places that the application can deliver an input source to the parser: as the argument to the Parser.parse method, or as the return value of the EntityResolver.resolveEntity method.

The SAX parser will use the InputSource object to determine how to read XML input. If there is a character stream available, the parser will read that stream directly, disregarding any text encoding declaration found in that stream. If there is no character stream, but there is a byte stream, the parser will use that byte stream, using the encoding specified in the InputSource or else (if no encoding is specified) autodetecting the character encoding using an algorithm such as the one in the XML specification. If neither a character stream nor a byte stream is available, the parser will attempt to open a URI connection to the resource identified by the system identifier.

An InputSource object belongs to the application: the SAX parser shall never modify it in any way (it may modify a copy if necessary). However, standard processing of both byte and character streams is to close them on as part of end-of-parse cleanup, so applications should not attempt to re-use such streams after they have been handed to a parser.

since
SAX 1.0
author
David Megginson
version
2.0.1 (sax2r2)
see
org.xml.sax.XMLReader#parse(org.xml.sax.InputSource)
see
org.xml.sax.EntityResolver#resolveEntity
see
java.io.InputStream
see
java.io.Reader

Fields Summary
private String
publicId
private String
systemId
private InputStream
byteStream
private String
encoding
private Reader
characterStream
Constructors Summary
public InputSource()
Zero-argument default constructor.

see
#setPublicId
see
#setSystemId
see
#setByteStream
see
#setCharacterStream
see
#setEncoding

    
public InputSource(String systemId)
Create a new input source with a system identifier.

Applications may use setPublicId to include a public identifier as well, or setEncoding to specify the character encoding, if known.

If the system identifier is a URL, it must be fully resolved (it may not be a relative URL).

param
systemId The system identifier (URI).
see
#setPublicId
see
#setSystemId
see
#setByteStream
see
#setEncoding
see
#setCharacterStream

    setSystemId(systemId);
    
public InputSource(InputStream byteStream)
Create a new input source with a byte stream.

Application writers should use setSystemId() to provide a base for resolving relative URIs, may use setPublicId to include a public identifier, and may use setEncoding to specify the object's character encoding.

param
byteStream The raw byte stream containing the document.
see
#setPublicId
see
#setSystemId
see
#setEncoding
see
#setByteStream
see
#setCharacterStream

    setByteStream(byteStream);
    
public InputSource(Reader characterStream)
Create a new input source with a character stream.

Application writers should use setSystemId() to provide a base for resolving relative URIs, and may use setPublicId to include a public identifier.

The character stream shall not include a byte order mark.

param
characterStream The raw character stream containing the document.
see
#setPublicId
see
#setSystemId
see
#setByteStream
see
#setCharacterStream

    setCharacterStream(characterStream);
    
Methods Summary
public java.io.InputStreamgetByteStream()
Get the byte stream for this input source.

The getEncoding method will return the character encoding for this byte stream, or null if unknown.

return
The byte stream, or null if none was supplied.
see
#getEncoding
see
#setByteStream

    return byteStream;
    
public java.io.ReadergetCharacterStream()
Get the character stream for this input source.

return
The character stream, or null if none was supplied.
see
#setCharacterStream

    return characterStream;
    
public java.lang.StringgetEncoding()
Get the character encoding for a byte stream or URI. This value will be ignored when the application provides a character stream.

return
The encoding, or null if none was supplied.
see
#setByteStream
see
#getSystemId
see
#getByteStream

    return encoding;
    
public java.lang.StringgetPublicId()
Get the public identifier for this input source.

return
The public identifier, or null if none was supplied.
see
#setPublicId

    return publicId;
    
public java.lang.StringgetSystemId()
Get the system identifier for this input source.

The getEncoding method will return the character encoding of the object pointed to, or null if unknown.

If the system ID is a URL, it will be fully resolved.

return
The system identifier, or null if none was supplied.
see
#setSystemId
see
#getEncoding

    return systemId;
    
public voidsetByteStream(java.io.InputStream byteStream)
Set the byte stream for this input source.

The SAX parser will ignore this if there is also a character stream specified, but it will use a byte stream in preference to opening a URI connection itself.

If the application knows the character encoding of the byte stream, it should set it with the setEncoding method.

param
byteStream A byte stream containing an XML document or other entity.
see
#setEncoding
see
#getByteStream
see
#getEncoding
see
java.io.InputStream

    this.byteStream = byteStream;
    
public voidsetCharacterStream(java.io.Reader characterStream)
Set the character stream for this input source.

If there is a character stream specified, the SAX parser will ignore any byte stream and will not attempt to open a URI connection to the system identifier.

param
characterStream The character stream containing the XML document or other entity.
see
#getCharacterStream
see
java.io.Reader

    this.characterStream = characterStream;
    
public voidsetEncoding(java.lang.String encoding)
Set the character encoding, if known.

The encoding must be a string acceptable for an XML encoding declaration (see section 4.3.3 of the XML 1.0 recommendation).

This method has no effect when the application provides a character stream.

param
encoding A string describing the character encoding.
see
#setSystemId
see
#setByteStream
see
#getEncoding

    this.encoding = encoding;
    
public voidsetPublicId(java.lang.String publicId)
Set the public identifier for this input source.

The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.

param
publicId The public identifier as a string.
see
#getPublicId
see
org.xml.sax.Locator#getPublicId
see
org.xml.sax.SAXParseException#getPublicId

    this.publicId = publicId;
    
public voidsetSystemId(java.lang.String systemId)
Set the system identifier for this input source.

The system identifier is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if there is no byte stream or character stream specified).

If the application knows the character encoding of the object pointed to by the system identifier, it can register the encoding using the setEncoding method.

If the system identifier is a URL, it must be fully resolved (it may not be a relative URL).

param
systemId The system identifier as a string.
see
#setEncoding
see
#getSystemId
see
org.xml.sax.Locator#getSystemId
see
org.xml.sax.SAXParseException#getSystemId

    this.systemId = systemId;