Added in API level 8

StreamSource

open class StreamSource : Source
kotlin.Any
   ↳ 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
static String

If javax.xml.transform.TransformerFactory#getFeature 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 File.
StreamSource(inputStream: InputStream!)

Construct a StreamSource from a byte stream.
StreamSource(inputStream: InputStream!, systemId: String!)

Construct a StreamSource from a byte stream.
StreamSource(reader: Reader!)

Construct a StreamSource from a character reader.
StreamSource(reader: Reader!, systemId: String!)

Construct a StreamSource from a character reader.
StreamSource(systemId: String!)

Construct a StreamSource from a URL.
Public methods
open InputStream!

Get the byte stream that was set with setByteStream.
open String!

Get the public identifier that was set with setPublicId.
open Reader!

Get the character stream that was set with setReader.
open String!

Get the system identifier that was set with setSystemId.
open Unit
setInputStream(inputStream: InputStream!)

Set the byte stream to be used as input.
open Unit
setPublicId(publicId: String!)

Set the public identifier for this Source.
open Unit
setReader(reader: Reader!)

Set the input to be a character reader.
open Unit

Set the system ID from a File reference.
open Unit
setSystemId(systemId: String!)

Set the system identifier for this Source.

Constants

FEATURE

Added in API level 8
static val FEATURE: String

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the Transformer supports Source input of this type.

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 inputStream) or setReader(java.io.Reader reader), then the Transformer will create an empty source java.io.InputStream using new InputStream().

See Also

    StreamSource

    Added in API level 8
    StreamSource(f: File!)

    Construct a StreamSource from a File.

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

    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!, 
        systemId: String!)

    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!, 
        systemId: String!)

    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(systemId: String!)

    Construct a StreamSource from a URL.

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

    Public methods

    getInputStream

    Added in API level 8
    open fun getInputStream(): InputStream!

    Get the byte stream that was set with setByteStream.

    Return
    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
    open fun getPublicId(): String!

    Get the public identifier that was set with setPublicId.

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

    getReader

    Added in API level 8
    open fun getReader(): Reader!

    Get the character stream that was set with setReader.

    Return
    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
    open fun getSystemId(): String!

    Get the system identifier that was set with setSystemId.

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

    setInputStream

    Added in API level 8
    open fun setInputStream(inputStream: InputStream!): Unit

    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
    open fun setPublicId(publicId: String!): Unit

    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
    open fun setReader(reader: Reader!): Unit

    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
    open fun setSystemId(f: File!): Unit

    Set the system ID from a File reference.

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

    setSystemId

    Added in API level 8
    open fun setSystemId(systemId: String!): Unit

    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.