LSOutput

  • The LSOutput interface represents an output destination for serialized DOM data, encapsulating information like URI, byte stream, and character stream.

  • Applications can provide their own LSOutput implementations or use the DOMImplementationLS.createLSOutput() factory method.

  • LSSerializer uses LSOutput to determine where to serialize, prioritizing characterStream, then byteStream, and finally systemId.

  • LSOutput objects are owned and managed by the application, with the DOM implementation only making copies if modifications are necessary.
public interface LSOutput

This interface represents an output destination for data.

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:

  1. LSOutput.characterStream
  2. LSOutput.byteStream
  3. 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.

Public Method Summary

abstract OutputStream
getByteStream()
An attribute of a language and binding dependent type that represents a writable stream of bytes.
abstract Writer
getCharacterStream()
An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output.
abstract String
getEncoding()
The character encoding to use for the output.
abstract String
getSystemId()
The system identifier, a URI reference [IETF RFC 2396], for this output destination.
abstract void
setByteStream(OutputStream byteStream)
An attribute of a language and binding dependent type that represents a writable stream of bytes.
abstract void
setCharacterStream(Writer characterStream)
An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output.
abstract void
setEncoding(String encoding)
The character encoding to use for the output.
abstract void
setSystemId(String systemId)
The system identifier, a URI reference [IETF RFC 2396], for this output destination.

Public Methods

public abstract OutputStream getByteStream ()

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

public abstract Writer getCharacterStream ()

An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output.

public abstract String getEncoding ()

The character encoding to use for the output. The encoding must be a string acceptable for an XML encoding declaration ([XML 1.0] section 4.3.3 "Character Encoding in Entities"), it is recommended that character encodings registered (as charsets) with the Internet Assigned Numbers Authority [IANA-CHARSETS] should be referred to using their registered names.

public abstract String getSystemId ()

The system identifier, a URI reference [IETF RFC 2396], for this output destination.
If the system ID is a relative URI reference (see section 5 in [IETF RFC 2396]), the behavior is implementation dependent.

public abstract void setByteStream (OutputStream byteStream)

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

Parameters
byteStream

public abstract void setCharacterStream (Writer characterStream)

An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output.

Parameters
characterStream

public abstract void setEncoding (String encoding)

The character encoding to use for the output. The encoding must be a string acceptable for an XML encoding declaration ([XML 1.0] section 4.3.3 "Character Encoding in Entities"), it is recommended that character encodings registered (as charsets) with the Internet Assigned Numbers Authority [IANA-CHARSETS] should be referred to using their registered names.

Parameters
encoding

public abstract void setSystemId (String systemId)

The system identifier, a URI reference [IETF RFC 2396], for this output destination.
If the system ID is a relative URI reference (see section 5 in [IETF RFC 2396]), the behavior is implementation dependent.

Parameters
systemId