InputSource (Org.XML.SAX Package)

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 will deliver this 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. If not, the parser will use a byte stream, if available. 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).

Constructors

Zero-argument default constructor.

Syntax:

public InputSource()

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 full resolved.

Syntax:

public InputSource(java.lang.String systemId)

Parameters:

systemId - The system identifier (URI).

Create a new input source with a byte stream. Application writers may use setSystemId to provide a base for resolving relative URIs, setPublicId to include a public identifier, and/or setEncoding to specify the object's character encoding.

Syntax:

public InputSource(java.io.InputStream byteStream)

Parameters:

byteStream - The raw byte stream containing the document.

Create a new input source with a character stream. Application writers may use setSystemId() to provide a base for resolving relative URIs, and setPublicId to include a public identifier. The character stream shall not include a byte order mark.

Syntax:

public InputSource(java.io.Reader characterStream).

See the following for methods.

getByteStream

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

Syntax:

public java.io.InputStream getByteStream()

Return value:

The byte stream, or null if none was supplied.

getCharacterStream

Gets the character stream for this input source.

Syntax:

public java.io.Reader getCharacterStream()

Return value:

The character stream, or null if none was supplied.

getEncoding

Gets the character encoding for a byte stream or URI.

Syntax:

public java.lang.String getEncoding()

Return value:

The encoding, or null if none was supplied.

getPublicID

Gets the public identifier for this input source.

Syntax:

public java.lang.String getPublicId()

Return value:

The public identifier, or null if none was supplied.

getSystemID

Gets 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.

Syntax:

public java.lang.String getSystemId()

Return value:

The system identifier.

setByteStream

Sets 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.

Syntax:

public void setByteStream(java.io.InputStream byteStream)

Parameters:

byteStream - A byte stream containing an XML document or other entity.

setCharacterStream

Sets 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.

Syntax:

public void setCharacterStream(java.io.Reader characterStream)

Parameters:

characterStream - The character stream containing the XML document or other entity.

setEncoding

Sets the character encoding, if known. The encoding must be a string acceptable for an XML encoding declaration. This method has no effect when the application provides a character stream.

Syntax:

public void setEncoding(java.lang.String encoding)

Parameters:

encoding - A string describing the character encoding.

setPublicID

Sets 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.

Syntax:

public void setPublicId(java.lang.String publicId)

Parameters:

publicId - The public identifier as a string.

setSystemID

Sets 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 ID is a URL, it must be fully resolved.

Syntax:

public void setSystemId(java.lang.String systemId)

Parameters:

systemId - The system identifier as a string.