public interface LSInput
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:
LSInput.characterStream
LSInput.byteStream
LSInput.stringData
LSInput.systemId
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.
Modifier and Type | Method | Description |
---|---|---|
String |
getBaseURI() |
The base URI to be used (see section 5.1.4 in [IETF RFC 2396]) for resolving a relative systemId to an absolute URI. |
InputStream |
getByteStream() |
An attribute of a language and binding dependent type that represents a stream of bytes. |
boolean |
getCertifiedText() |
|
Reader |
getCharacterStream() |
An attribute of a language and binding dependent type that represents a stream of 16-bit units. |
String |
getEncoding() |
The character encoding, if known. |
String |
getPublicId() |
The public identifier for this input source. |
String |
getStringData() |
String data to parse. |
String |
getSystemId() |
The system identifier, a URI reference [IETF RFC 2396], for this input source. |
void |
setBaseURI |
The base URI to be used (see section 5.1.4 in [IETF RFC 2396]) for resolving a relative systemId to an absolute URI. |
void |
setByteStream |
An attribute of a language and binding dependent type that represents a stream of bytes. |
void |
setCertifiedText |
|
void |
setCharacterStream |
An attribute of a language and binding dependent type that represents a stream of 16-bit units. |
void |
setEncoding |
The character encoding, if known. |
void |
setPublicId |
The public identifier for this input source. |
void |
setStringData |
String data to parse. |
void |
setSystemId |
The system identifier, a URI reference [IETF RFC 2396], for this input source. |
Reader getCharacterStream()
void setCharacterStream(Reader characterStream)
InputStream getByteStream()
void setByteStream(InputStream byteStream)
String getStringData()
stringData
. If an XML declaration is present, the value of the encoding attribute will be ignored.void setStringData(String stringData)
stringData
. If an XML declaration is present, the value of the encoding attribute will be ignored.String getSystemId()
encoding
attribute. baseURI
as the base, if that fails, the behavior is implementation dependent.void setSystemId(String systemId)
encoding
attribute. baseURI
as the base, if that fails, the behavior is implementation dependent.String getPublicId()
void setPublicId(String publicId)
String getBaseURI()
systemId
to an absolute URI. void setBaseURI(String baseURI)
systemId
to an absolute URI. String getEncoding()
void setEncoding(String encoding)
boolean getCertifiedText()
void setCertifiedText(boolean certifiedText)
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/org/w3c/dom/ls/LSInput.html