File	Doc	Category	Size	Date	Package
StreamSource.java	API Doc	Java SE 6 API	9688	Tue Jun 10 00:27:14 BST 2008	javax.xml.transform.stream

StreamSource

• java.lang.Object

Fields Summary
public static final String	FEATURE If {@link javax.xml.transform.TransformerFactory#getFeature} returns true when passed this value as an argument, the Transformer supports Source input of this type.
private String	publicId The public identifier for this input source, or null.
private String	systemId The system identifier as a URL string, or null.
private InputStream	inputStream The byte stream for this Source, or null.
private Reader	reader The character stream for this Source, or null.

Constructors Summary
public StreamSource() Zero-argument default constructor. If this constructor is used, and no Stream source is set using {@link #setInputStream(java.io.InputStream inputStream)} or {@link #setReader(java.io.Reader reader)}, then the Transformer will create an empty source {@link java.io.InputStream} using {@link java.io.InputStream#InputStream() new InputStream()}. see javax.xml.transform.Transformer#transform(Source xmlSource, Result outputTarget)
public StreamSource(InputStream inputStream) Construct a StreamSource from a byte stream. Normally, a stream should be used rather than a reader, so the XML parser can resolve character encoding specified by the XML declaration. If this constructor is used to process a stylesheet, normally setSystemId should also be called, so that relative URI references can be resolved. param inputStream A valid InputStream reference to an XML stream. setInputStream(inputStream);
public StreamSource(InputStream inputStream, String systemId) Construct a StreamSource from a byte stream. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration. This constructor allows the systemID to be set in addition to the input stream, which allows relative URIs to be processed. param inputStream A valid InputStream reference to an XML stream. param systemId Must be a String that conforms to the URI syntax. setInputStream(inputStream); setSystemId(systemId);
public StreamSource(Reader reader) Construct a StreamSource from a character reader. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration. However, in many cases the encoding of the input stream is already resolved, as in the case of reading XML from a StringReader. param reader A valid Reader reference to an XML character stream. setReader(reader);
public StreamSource(Reader reader, String systemId) Construct a StreamSource from a character reader. Normally, a stream should be used rather than a reader, so that the XML parser may resolve character encoding specified by the XML declaration. However, in many cases the encoding of the input stream is already resolved, as in the case of reading XML from a StringReader. param reader A valid Reader reference to an XML character stream. param systemId Must be a String that conforms to the URI syntax. setReader(reader); setSystemId(systemId);
public StreamSource(String systemId) Construct a StreamSource from a URL. param systemId Must be a String that conforms to the URI syntax. this.systemId = systemId;
public StreamSource(File f) Construct a StreamSource from a File. param f Must a non-null File reference. //convert file to appropriate URI, f.toURI().toASCIIString() //converts the URI to string as per rule specified in //RFC 2396, setSystemId(f.toURI().toASCIIString());

Methods Summary
public java.io.InputStream	getInputStream() Get the byte stream that was set with setByteStream. return The byte stream that was set with setByteStream, or null if setByteStream or the ByteStream constructor was not called. return inputStream;
public java.lang.String	getPublicId() Get the public identifier that was set with setPublicId. return The public identifier that was set with setPublicId, or null if setPublicId was not called. return publicId;
public java.io.Reader	getReader() Get the character stream that was set with setReader. return The character stream that was set with setReader, or null if setReader or the Reader constructor was not called. return reader;
public java.lang.String	getSystemId() Get the system identifier that was set with setSystemId. return The system identifier that was set with setSystemId, or null if setSystemId was not called. return systemId;
public void	setInputStream(java.io.InputStream inputStream) Set the byte stream to be used as input. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration. If this Source object is used to process a stylesheet, normally setSystemId should also be called, so that relative URL references can be resolved. param inputStream A valid InputStream reference to an XML stream. this.inputStream = inputStream;
public void	setPublicId(java.lang.String publicId) Set the public identifier for this 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. this.publicId = publicId;
public void	setReader(java.io.Reader reader) Set the input to be a character reader. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration. However, in many cases the encoding of the input stream is already resolved, as in the case of reading XML from a StringReader. param reader A valid Reader reference to an XML CharacterStream. this.reader = reader;
public void	setSystemId(java.lang.String systemId) Set the system identifier for this 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). param systemId The system identifier as a URL string. this.systemId = systemId;
public void	setSystemId(java.io.File f) Set the system ID from a File reference. param f Must a non-null File reference. //convert file to appropriate URI, f.toURI().toASCIIString() //converts the URI to string as per rule specified in //RFC 2396, this.systemId = f.toURI().toASCIIString();