org.w3c.dom.ls
Interface DOMOutput

public interface DOMOutput

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.createDOMOutput() to create objects that implement this interface.

The DOMSerializer will use the DOMOutput object to determine where to serialize the output to. The DOMSerializer will look at the different outputs specified in the DOMOutput in the following order to know which one to output to, the first one that data can be output to will be used:

1. DOMOutput.characterStream
2. DOMOutput.byteStream
3. DOMOutput.systemId

DOMOutput 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.

Method Summary

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

Method Detail

getCharacterStream

public java.io.Writer getCharacterStream()

An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output. The application must encode the stream using UTF-16 (defined in [Unicode] and Amendment 1 of [ISO/IEC 10646]).

setCharacterStream

public void setCharacterStream(java.io.Writer characterStream)

An attribute of a language and binding dependent type that represents a writable stream to which 16-bit units can be output. The application must encode the stream using UTF-16 (defined in [Unicode] and Amendment 1 of [ISO/IEC 10646]).

getByteStream

public java.io.OutputStream getByteStream()

An attribute of a language and binding dependent type that represents a writable 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.

setByteStream

public void setByteStream(java.io.OutputStream byteStream)

An attribute of a language and binding dependent type that represents a writable 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.

getSystemId

public java.lang.String getSystemId()

The system identifier, a URI reference [IETF RFC 2396], for this output destination.
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 system ID is a relative URI reference (see section 5 in [IETF RFC 2396]), the behavior is implementation dependent.

setSystemId

public void setSystemId(java.lang.String systemId)

The system identifier, a URI reference [IETF RFC 2396], for this output destination.
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 system ID is a relative URI reference (see section 5 in [IETF RFC 2396]), the behavior is implementation dependent.

getEncoding

public java.lang.String getEncoding()

The character encoding, if known. The encoding must be a string acceptable for an XML encoding declaration ([XML 1.0] 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].

setEncoding

public void setEncoding(java.lang.String encoding)

The character encoding, if known. The encoding must be a string acceptable for an XML encoding declaration ([XML 1.0] 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].