# LSInput

public interface **LSInput** This interface represents an input source for data.

This interface allows an application to encapsulate information about
an input source in a single object, which may include a public
identifier, a system identifier, a byte stream (possibly with a specified
encoding), a base URI, and/or a character stream.

The exact definitions of a byte stream and a character stream are
binding dependent.

The application is expected to provide objects that implement this
interface whenever such objects are needed. The application can either
provide its own objects that implement this interface, or it can use the
generic factory method `DOMImplementationLS.createLSInput()`
to create objects that implement this interface.

The `LSParser` will use the `LSInput` object to
determine how to read data. The `LSParser` will look at the
different inputs specified in the `LSInput` in the following
order to know which one to read from, the first one that is not null and
not an empty string will be used:

1. `LSInput.characterStream`
2. `LSInput.byteStream`
3. `LSInput.stringData`
4. `LSInput.systemId`
5. `LSInput.publicId`

If all inputs are null, the `LSParser` will report a
`DOMError` with its `DOMError.type` set to
`"no-input-specified"` and its `DOMError.severity`
set to `DOMError.SEVERITY_FATAL_ERROR`.

`LSInput` objects belong to the application. The DOM
implementation will never modify them (though it may make copies and
modify the copies, if necessary).

See also the [Document Object Model (DOM) Level 3 Load
and Save Specification](http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407).

### Public Method Summary

|---|---|
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getBaseURI](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getBaseURI())() The base URI to be used (see section 5.1.4 in \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\]) for resolving a relative `systemId` to an absolute URI. |
| abstract [InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) | [getByteStream](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getByteStream())() An attribute of a language and binding dependent type that represents a stream of bytes. |
| abstract boolean | [getCertifiedText](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getCertifiedText())() If set to true, assume that the input is certified (see section 2.13 in \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\]) when parsing \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\]. |
| abstract [Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) | [getCharacterStream](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getCharacterStream())() An attribute of a language and binding dependent type that represents a stream of 16-bit units. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getEncoding](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getEncoding())() The character encoding, if known. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getPublicId](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getPublicId())() The public identifier for this input source. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getStringData](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getStringData())() String data to parse. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#getSystemId())() The system identifier, a URI reference \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\], for this input source. |
| abstract void | [setBaseURI](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setBaseURI(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) baseURI) The base URI to be used (see section 5.1.4 in \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\]) for resolving a relative `systemId` to an absolute URI. |
| abstract void | [setByteStream](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setByteStream(java.io.InputStream))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) byteStream) An attribute of a language and binding dependent type that represents a stream of bytes. |
| abstract void | [setCertifiedText](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setCertifiedText(boolean))(boolean certifiedText) If set to true, assume that the input is certified (see section 2.13 in \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\]) when parsing \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\]. |
| abstract void | [setCharacterStream](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setCharacterStream(java.io.Reader))([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) characterStream) An attribute of a language and binding dependent type that represents a stream of 16-bit units. |
| abstract void | [setEncoding](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setEncoding(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) encoding) The character encoding, if known. |
| abstract void | [setPublicId](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setPublicId(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) publicId) The public identifier for this input source. |
| abstract void | [setStringData](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setStringData(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) stringData) String data to parse. |
| abstract void | [setSystemId](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/ls/LSInput.html#setSystemId(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) systemId) The system identifier, a URI reference \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\], for this input source. |

## Public Methods

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

The base URI to be used (see section 5.1.4 in \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\]) for
resolving a relative `systemId` to an absolute URI.

If, when used, the base URI is itself a relative URI, an empty
string, or null, the behavior is implementation dependent.

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

An attribute of a language and binding dependent type that represents
a stream of bytes.

If the application knows the character encoding of the byte
stream, it should set the encoding attribute. Setting the encoding in
this way will override any encoding specified in an XML declaration
in the data.

#### public abstract boolean
**getCertifiedText**
()

If set to true, assume that the input is certified (see section 2.13
in \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\]) when
parsing \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\].

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

An attribute of a language and binding dependent type that represents
a stream of 16-bit units. The application must encode the stream
using UTF-16 (defined in \[Unicode\] and in \[ISO/IEC 10646\]). It is not a requirement to have an XML declaration when
using character streams. If an XML declaration is present, the value
of the encoding attribute will be ignored.

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

The character encoding, if known. The encoding must be a string
acceptable for an XML encoding declaration (\[[XML 1.0](http://www.w3.org/TR/2004/REC-xml-20040204)\] section
4.3.3 "Character Encoding in Entities").

This attribute has no effect when the application provides a
character stream or string data. For other sources of input, an
encoding specified by means of this attribute will override any
encoding specified in the XML declaration or the Text declaration, or
an encoding obtained from a higher level protocol, such as HTTP \[[IETF RFC 2616](http://www.ietf.org/rfc/rfc2616.txt)\].

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

The public identifier for this input source. This may be mapped to an
input source using an implementation dependent mechanism (such as
catalogues or other mappings). The public identifier, if specified,
may also be reported as part of the location information when errors
are reported.

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

String data to parse. If provided, this will always be treated as a
sequence of 16-bit units (UTF-16 encoded characters). It is not a
requirement to have an XML declaration when using
`stringData`. If an XML declaration is present, the value
of the encoding attribute will be ignored.

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

The system identifier, a URI reference \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\], for this
input source. The system identifier is optional if there is a byte
stream, a character stream, or string data. It is still useful to
provide one, since the application will use it to resolve any
relative URIs and can include it in error messages and warnings. (The
LSParser will only attempt to fetch the resource identified by the
URI reference if there is no other input available in the input
source.)

If the application knows the character encoding of the object
pointed to by the system identifier, it can set the encoding using
the `encoding` attribute.

If the specified system ID is a relative URI reference (see
section 5 in \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\]), the DOM
implementation will attempt to resolve the relative URI with the
`baseURI` as the base, if that fails, the behavior is
implementation dependent.

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

The base URI to be used (see section 5.1.4 in \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\]) for
resolving a relative `systemId` to an absolute URI.

If, when used, the base URI is itself a relative URI, an empty
string, or null, the behavior is implementation dependent.

##### Parameters

| baseURI |   |
|---|---|

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

An attribute of a language and binding dependent type that represents
a stream of bytes.

If the application knows the character encoding of the byte
stream, it should set the encoding attribute. Setting the encoding in
this way will override any encoding specified in an XML declaration
in the data.

##### Parameters

| byteStream |   |
|---|---|

#### public abstract void
**setCertifiedText**
(boolean certifiedText)

If set to true, assume that the input is certified (see section 2.13
in \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\]) when
parsing \[[XML 1.1](http://www.w3.org/TR/2004/REC-xml11-20040204/)\].

##### Parameters

| certifiedText |   |
|---|---|

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

An attribute of a language and binding dependent type that represents
a stream of 16-bit units. The application must encode the stream
using UTF-16 (defined in \[Unicode\] and in \[ISO/IEC 10646\]). It is not a requirement to have an XML declaration when
using character streams. If an XML declaration is present, the value
of the encoding attribute will be ignored.

##### Parameters

| characterStream |   |
|---|---|

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

The character encoding, if known. The encoding must be a string
acceptable for an XML encoding declaration (\[[XML 1.0](http://www.w3.org/TR/2004/REC-xml-20040204)\] section
4.3.3 "Character Encoding in Entities").

This attribute has no effect when the application provides a
character stream or string data. For other sources of input, an
encoding specified by means of this attribute will override any
encoding specified in the XML declaration or the Text declaration, or
an encoding obtained from a higher level protocol, such as HTTP \[[IETF RFC 2616](http://www.ietf.org/rfc/rfc2616.txt)\].

##### Parameters

| encoding |   |
|---|---|

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

The public identifier for this input source. This may be mapped to an
input source using an implementation dependent mechanism (such as
catalogues or other mappings). The public identifier, if specified,
may also be reported as part of the location information when errors
are reported.

##### Parameters

| publicId |   |
|---|---|

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

String data to parse. If provided, this will always be treated as a
sequence of 16-bit units (UTF-16 encoded characters). It is not a
requirement to have an XML declaration when using
`stringData`. If an XML declaration is present, the value
of the encoding attribute will be ignored.

##### Parameters

| stringData |   |
|---|---|

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

The system identifier, a URI reference \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\], for this
input source. The system identifier is optional if there is a byte
stream, a character stream, or string data. It is still useful to
provide one, since the application will use it to resolve any
relative URIs and can include it in error messages and warnings. (The
LSParser will only attempt to fetch the resource identified by the
URI reference if there is no other input available in the input
source.)

If the application knows the character encoding of the object
pointed to by the system identifier, it can set the encoding using
the `encoding` attribute.

If the specified system ID is a relative URI reference (see
section 5 in \[[IETF RFC 2396](http://www.ietf.org/rfc/rfc2396.txt)\]), the DOM
implementation will attempt to resolve the relative URI with the
`baseURI` as the base, if that fails, the behavior is
implementation dependent.

##### Parameters

| systemId |   |
|---|---|