org.htmlunit.cyberneko.xerces.xni.parser

Class XMLInputSource

java.lang.Object

org.htmlunit.cyberneko.xerces.xni.parser.XMLInputSource

public class XMLInputSource
extends Object

This class represents an input source for an XML document. The basic properties of an input source are the following:

• public identifier
• system identifier
• byte stream or character stream

Author:

Andy Clark, IBM

Constructor Summary

Constructors

Constructor and Description
XMLInputSource(String publicId, String systemId, String baseSystemId) Constructs an input source from just the public and system identifiers, leaving resolution of the entity and opening of the input stream up to the caller.
XMLInputSource(String publicId, String systemId, String baseSystemId, InputStream byteStream, String encoding) Constructs an input source from a byte stream.
XMLInputSource(String publicId, String systemId, String baseSystemId, Reader charStream, String encoding) Constructs an input source from a character stream.

Method Summary

Modifier and Type	Method and Description
String	getBaseSystemId()
InputStream	getByteStream()
Reader	getCharacterStream()
String	getEncoding()
String	getPublicId()
String	getSystemId()
void	setBaseSystemId(String baseSystemId) Sets the base system identifier.
void	setByteStream(InputStream byteStream) Sets the byte stream.
void	setCharacterStream(Reader charStream) Sets the character stream.
void	setEncoding(String encoding) Sets the encoding of the stream.
void	setPublicId(String publicId) Sets the public identifier.
void	setSystemId(String systemId) Sets the system identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLInputSource

public XMLInputSource(String publicId,
                      String systemId,
                      String baseSystemId)

Constructs an input source from just the public and system identifiers, leaving resolution of the entity and opening of the input stream up to the caller.

Parameters:

publicId - The public identifier, if known.

systemId - The system identifier. This value should always be set, if possible, and can be relative or absolute. If the system identifier is relative, then the base system identifier should be set.

baseSystemId - The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.

XMLInputSource

public XMLInputSource(String publicId,
                      String systemId,
                      String baseSystemId,
                      InputStream byteStream,
                      String encoding)

Constructs an input source from a byte stream.

Parameters:

publicId - The public identifier, if known.

systemId - The system identifier. This value should always be set, if possible, and can be relative or absolute. If the system identifier is relative, then the base system identifier should be set.

baseSystemId - The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.

byteStream - The byte stream.

encoding - The encoding of the byte stream, if known.

XMLInputSource

public XMLInputSource(String publicId,
                      String systemId,
                      String baseSystemId,
                      Reader charStream,
                      String encoding)

Constructs an input source from a character stream.

Parameters:

publicId - The public identifier, if known.

systemId - The system identifier. This value should always be set, if possible, and can be relative or absolute. If the system identifier is relative, then the base system identifier should be set.

baseSystemId - The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.

charStream - The character stream.

encoding - The original encoding of the byte stream used by the reader, if known.

Method Detail

setPublicId

public void setPublicId(String publicId)

Sets the public identifier.

Parameters:

publicId - The new public identifier.

getPublicId

public String getPublicId()

Returns:

the public identifier.

setSystemId

public void setSystemId(String systemId)

Sets the system identifier.

Parameters:

systemId - The new system identifier.

getSystemId

public String getSystemId()

Returns:

the system identifier.

setBaseSystemId

public void setBaseSystemId(String baseSystemId)

Sets the base system identifier.

Parameters:

baseSystemId - The new base system identifier.

getBaseSystemId

public String getBaseSystemId()

Returns:

the base system identifier.

setByteStream

public void setByteStream(InputStream byteStream)

Sets the byte stream. If the byte stream is not already opened when this object is instantiated, then the code that opens the stream should also set the byte stream on this object. Also, if the encoding is auto-detected, then the encoding should also be set on this object.

Parameters:

byteStream - The new byte stream.

getByteStream

public InputStream getByteStream()

Returns:

the byte stream.

setCharacterStream

public void setCharacterStream(Reader charStream)

Sets the character stream. If the character stream is not already opened when this object is instantiated, then the code that opens the stream should also set the character stream on this object. Also, the encoding of the byte stream used by the reader should also be set on this object, if known.

Parameters:

charStream - The new character stream.

See Also:

setEncoding(String)

getCharacterStream

public Reader getCharacterStream()

Returns:

the character stream.

setEncoding

public void setEncoding(String encoding)

Sets the encoding of the stream.

Parameters:

encoding - The new encoding.

getEncoding

public String getEncoding()

Returns:

the encoding of the stream, or null if not known.