# StreamSource

public class **StreamSource** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
implements [Source](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Source.html) <br />

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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html` instance,
`StreamSource` instances may only be used once.

<br />

### Constant Summary

|---|---|---|
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [FEATURE](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#FEATURE) | If `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/TransformerFactory.html#getFeature(java.lang.String)` returns true when passed this value as an argument, the Transformer supports Source input of this type. |

### Public Constructor Summary

|---|---|
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource())() Zero-argument default constructor. |
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource(java.io.InputStream))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) inputStream) Construct a StreamSource from a byte stream. |
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource(java.io.InputStream,%20java.lang.String))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) inputStream, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId) Construct a StreamSource from a byte stream. |
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource(java.io.Reader))([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) reader) Construct a StreamSource from a character reader. |
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource(java.io.Reader,%20java.lang.String))([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) reader, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId) Construct a StreamSource from a character reader. |
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId) Construct a StreamSource from a URL. |
|   | [StreamSource](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#StreamSource(java.io.File))([File](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/File.html) f) Construct a StreamSource from a File. |

### Public Method Summary

|---|---|
| [InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) | [getInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#getInputStream())() Get the byte stream that was set with setByteStream. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getPublicId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#getPublicId())() Get the public identifier that was set with setPublicId. |
| [Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) | [getReader](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#getReader())() Get the character stream that was set with setReader. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#getSystemId())() Get the system identifier that was set with setSystemId. |
| void | [setInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setInputStream(java.io.InputStream))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) inputStream) Set the byte stream to be used as input. |
| void | [setPublicId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setPublicId(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) publicId) Set the public identifier for this Source. |
| void | [setReader](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setReader(java.io.Reader))([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) reader) Set the input to be a character reader. |
| void | [setSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setSystemId(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId) Set the system identifier for this Source. |
| void | [setSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setSystemId(java.io.File))([File](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/File.html) f) Set the system ID from a File reference. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [javax.xml.transform.Source](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Source.html)

|---|---|
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Source.html#getSystemId())() Get the system identifier that was set with setSystemId. |
| abstract void | [setSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Source.html#setSystemId(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId) Set the system identifier for this Source. |

## Constants

#### public static final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**FEATURE**

If `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/TransformerFactory.html#getFeature(java.lang.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

#### public
**StreamSource**
()

<br />

Zero-argument default constructor. If this constructor is used, and
no Stream source is set using
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setInputStream(java.io.InputStream)` or
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/stream/StreamSource.html#setReader(java.io.Reader)`, then the
`Transformer` will
create an empty source `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html` using
`https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#InputStream()`.

<br />

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/xml/transform/Transformer.html#transform(javax.xml.transform.Source,%20javax.xml.transform.Result)`

#### public
**StreamSource**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) 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.

<br />

##### Parameters

| inputStream | A valid InputStream reference to an XML stream. |
|---|---|

#### public
**StreamSource**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) inputStream, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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.

<br />

##### Parameters

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

#### public
**StreamSource**
([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) 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 | A valid Reader reference to an XML character stream. |
|---|---|

#### public
**StreamSource**
([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) reader, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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 | A valid Reader reference to an XML character stream. |
| systemId | Must be a String that conforms to the URI syntax. |
|---|---|

#### public
**StreamSource**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId)

Construct a StreamSource from a URL.

##### Parameters

| systemId | Must be a String that conforms to the URI syntax. |
|---|---|

#### public
**StreamSource**
([File](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/File.html) f)

Construct a StreamSource from a File.

##### Parameters

| f | Must a non-null File reference. |
|---|---|

## Public Methods

#### public [InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html)
**getInputStream**
()

Get the byte stream that was set with setByteStream.

##### Returns

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

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getPublicId**
()

Get the public identifier that was set with setPublicId.

##### Returns

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

#### public [Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html)
**getReader**
()

Get the character stream that was set with setReader.

##### Returns

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

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getSystemId**
()

Get the system identifier that was set with setSystemId.

##### Returns

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

#### public void
**setInputStream**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) 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.

<br />

##### Parameters

| inputStream | A valid InputStream reference to an XML stream. |
|---|---|

#### public void
**setPublicId**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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.

<br />

##### Parameters

| publicId | The public identifier as a string. |
|---|---|

#### public void
**setReader**
([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) 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 | A valid Reader reference to an XML CharacterStream. |
|---|---|

#### public void
**setSystemId**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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).

<br />

##### Parameters

| systemId | The system identifier as a URL string. |
|---|---|

#### public void
**setSystemId**
([File](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/File.html) f)

Set the system ID from a File reference.

##### Parameters

| f | Must a non-null File reference. |
|---|---|