|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
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.
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 to use for the output. |
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 to use for the output. |
void |
setSystemId(java.lang.String systemId)
The system identifier, a URI reference [IETF RFC 2396], for this output destination. |
Method Detail |
---|
java.io.Writer getCharacterStream()
void setCharacterStream(java.io.Writer characterStream)
java.io.OutputStream getByteStream()
void setByteStream(java.io.OutputStream byteStream)
java.lang.String getSystemId()
void setSystemId(java.lang.String systemId)
java.lang.String getEncoding()
void setEncoding(java.lang.String encoding)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |