Skip to content

Most visited

Recently visited

navigation
Added in API level 8

LSOutput

public interface LSOutput

org.w3c.dom.ls.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.

Summary

Public methods

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

getByteStream

Added in API level 8
OutputStream getByteStream ()

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

Returns
OutputStream

getCharacterStream

Added in API level 8
Writer getCharacterStream ()

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

Returns
Writer

getEncoding

Added in API level 8
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.

Returns
String

getSystemId

Added in API level 8
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.

Returns
String

setByteStream

Added in API level 8
void setByteStream (OutputStream byteStream)

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

Parameters
byteStream OutputStream

setCharacterStream

Added in API level 8
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 Writer

setEncoding

Added in API level 8
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 String

setSystemId

Added in API level 8
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 String
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.