| java.lang.Object | |
| ↳ | javax.xml.transform.stream.StreamSource |
Acts as an holder for a transformation Source in the form of a stream of XML markup.
Note: Due to their internal use of either a Reader or InputStream instance,
StreamSource instances may only be used once.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | FEATURE |
If getFeature(String)
returns true when passed this value as an argument,
the Transformer supports Source input of this type.
|
|||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Zero-argument default constructor. | |||||||||||
Construct a StreamSource from a byte stream.
| |||||||||||
Construct a StreamSource from a byte stream.
| |||||||||||
Construct a StreamSource from a character reader.
| |||||||||||
Construct a StreamSource from a character reader.
| |||||||||||
Construct a StreamSource from a URL.
| |||||||||||
Construct a StreamSource from a File.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Get the byte stream that was set with setByteStream.
| |||||||||||
Get the public identifier that was set with setPublicId.
| |||||||||||
Get the character stream that was set with setReader.
| |||||||||||
Get the system identifier that was set with setSystemId.
| |||||||||||
Set the byte stream to be used as input.
| |||||||||||
Set the public identifier for this Source.
| |||||||||||
Set the input to be a character reader.
| |||||||||||
Set the system ID from a File reference.
| |||||||||||
Set the system identifier for this Source.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
javax.xml.transform.Source
| |||||||||||
If getFeature(String)
returns true when passed this value as an argument,
the Transformer supports Source input of this type.
Zero-argument default constructor. If this constructor is used, and
no Stream source is set using
setInputStream(java.io.InputStream) or
setReader(java.io.Reader), then the
Transformer will
create an empty source InputStream using
new 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.
| inputStream | A valid InputStream reference to an XML stream. |
|---|
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.
| inputStream | A valid InputStream reference to an XML stream. |
|---|---|
| systemId | Must be a String that conforms to the URI syntax. |
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.
| reader | A valid Reader reference to an XML character stream. |
|---|
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.
| reader | A valid Reader reference to an XML character stream. |
|---|---|
| systemId | Must be a String that conforms to the URI syntax. |
Construct a StreamSource from a URL.
| systemId | Must be a String that conforms to the URI syntax. |
|---|
Construct a StreamSource from a File.
| f | Must a non-null File reference. |
|---|
Get the byte stream that was set with setByteStream.
Get the public identifier that was set with setPublicId.
Get the character stream that was set with setReader.
Get the system identifier that was set with setSystemId.
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.
| inputStream | A valid InputStream reference to an XML stream. |
|---|
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.
| publicId | The public identifier as a string. |
|---|
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.
| reader | A valid Reader reference to an XML CharacterStream. |
|---|
Set the system ID from a File reference.
| f | Must a non-null File reference. |
|---|
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).
| systemId | The system identifier as a URL string. |
|---|
Developers