Skip to content

Most visited

Recently visited

navigation
Added in API level 8

StreamSource

public class StreamSource
extends Object implements Source

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.

Summary

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

StreamSource()

Zero-argument default constructor.

StreamSource(InputStream inputStream)

Construct a StreamSource from a byte stream.

StreamSource(InputStream inputStream, String systemId)

Construct a StreamSource from a byte stream.

StreamSource(Reader reader)

Construct a StreamSource from a character reader.

StreamSource(Reader reader, String systemId)

Construct a StreamSource from a character reader.

StreamSource(String systemId)

Construct a StreamSource from a URL.

StreamSource(File f)

Construct a StreamSource from a File.

Public methods

InputStream getInputStream()

Get the byte stream that was set with setByteStream.

String getPublicId()

Get the public identifier that was set with setPublicId.

Reader getReader()

Get the character stream that was set with setReader.

String getSystemId()

Get the system identifier that was set with setSystemId.

void setInputStream(InputStream inputStream)

Set the byte stream to be used as input.

void setPublicId(String publicId)

Set the public identifier for this Source.

void setReader(Reader reader)

Set the input to be a character reader.

void setSystemId(String systemId)

Set the system identifier for this Source.

void setSystemId(File f)

Set the system ID from a File reference.

Inherited methods

From class java.lang.Object
From interface javax.xml.transform.Source

Constants

FEATURE

Added in API level 8
String FEATURE

If getFeature(String) returns true when passed this value as an argument, the Transformer supports Source input of this type.

Constant Value: "http://javax.xml.transform.stream.StreamSource/feature"

Public constructors

StreamSource

Added in API level 8
StreamSource ()

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().

See also:

StreamSource

Added in API level 8
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.

Parameters
inputStream InputStream: A valid InputStream reference to an XML stream.

StreamSource

Added in API level 8
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.

Parameters
inputStream InputStream: A valid InputStream reference to an XML stream.
systemId String: Must be a String that conforms to the URI syntax.

StreamSource

Added in API level 8
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.

Parameters
reader Reader: A valid Reader reference to an XML character stream.

StreamSource

Added in API level 8
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.

Parameters
reader Reader: A valid Reader reference to an XML character stream.
systemId String: Must be a String that conforms to the URI syntax.

StreamSource

Added in API level 8
StreamSource (String systemId)

Construct a StreamSource from a URL.

Parameters
systemId String: Must be a String that conforms to the URI syntax.

StreamSource

Added in API level 8
StreamSource (File f)

Construct a StreamSource from a File.

Parameters
f File: Must a non-null File reference.

Public methods

getInputStream

Added in API level 8
InputStream getInputStream ()

Get the byte stream that was set with setByteStream.

Returns
InputStream The byte stream that was set with setByteStream, or null if setByteStream or the ByteStream constructor was not called.

getPublicId

Added in API level 8
String getPublicId ()

Get the public identifier that was set with setPublicId.

Returns
String The public identifier that was set with setPublicId, or null if setPublicId was not called.

getReader

Added in API level 8
Reader getReader ()

Get the character stream that was set with setReader.

Returns
Reader The character stream that was set with setReader, or null if setReader or the Reader constructor was not called.

getSystemId

Added in API level 8
String getSystemId ()

Get the system identifier that was set with setSystemId.

Returns
String The system identifier that was set with setSystemId, or null if setSystemId was not called.

setInputStream

Added in API level 8
void setInputStream (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.

Parameters
inputStream InputStream: A valid InputStream reference to an XML stream.

setPublicId

Added in API level 8
void setPublicId (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.

Parameters
publicId String: The public identifier as a string.

setReader

Added in API level 8
void setReader (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.

Parameters
reader Reader: A valid Reader reference to an XML CharacterStream.

setSystemId

Added in API level 8
void setSystemId (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).

Parameters
systemId String: The system identifier as a URL string.

setSystemId

Added in API level 8
void setSystemId (File f)

Set the system ID from a File reference.

Parameters
f File: Must a non-null File reference.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.