public interface LSOutput
This interface allows an application to encapsulate information about an output destination in a single object, which may include a URI, 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.createLSOutput()
to create objects that implement this interface.
The LSSerializer
will use the LSOutput
object to determine where to serialize the output to. The LSSerializer
will look at the different outputs specified in the LSOutput
in the following order to know which one to output to, the first one that is not null and not an empty string will be used:
LSOutput.characterStream
LSOutput.byteStream
LSOutput.systemId
LSOutput
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 |
---|---|---|
OutputStream |
getByteStream() |
An attribute of a language and binding dependent type that represents a writable stream of bytes. |
Writer |
getCharacterStream() |
An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output. |
String |
getEncoding() |
The character encoding to use for the output. |
String |
getSystemId() |
The system identifier, a URI reference [IETF RFC 2396], for this output destination. |
void |
setByteStream |
An attribute of a language and binding dependent type that represents a writable stream of bytes. |
void |
setCharacterStream |
An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output. |
void |
setEncoding |
The character encoding to use for the output. |
void |
setSystemId |
The system identifier, a URI reference [IETF RFC 2396], for this output destination. |
Writer getCharacterStream()
void setCharacterStream(Writer characterStream)
OutputStream getByteStream()
void setByteStream(OutputStream byteStream)
String getSystemId()
void setSystemId(String systemId)
String getEncoding()
void setEncoding(String encoding)
© 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/LSOutput.html