org.w3c.dom.ls

インタフェース LSOutput

public interface LSOutput

このインタフェースはデータの出力先を表します。

このインタフェースを使用すると、アプリケーションで、出力先に関する情報を単一のオブジェクトにカプセル化できます。 このオブジェクトには、URI、バイトストリーム (エンコーディングが指定されている場合もある)、ベース URI、あるいは文字ストリームなどが含まれます。

バイトストリームと文字ストリームの正確な定義は、バインディングによって異なります。

アプリケーションは、前述のようなオブジェクトが必要なときはいつでも、このインタフェースを実装するオブジェクトを持つことが求められます。アプリケーションでは、このインタフェースを実装する独自のオブジェクトを提供したり、ジェネリックなファクトリメソッドの DOMImplementationLS.createLSOutput() を使用してこのインタフェースを実装するオブジェクトを作成したりできます。

LSSerializer は、LSOutput オブジェクトを使用して、出力を直列化する場所を決定します。LSSerializer は、LSOutput で指定された異なる出力を次の順序で検索して、出力先を認識します。null ではなく、空の文字列でもない最初の出力が使用されます。

1. LSOutput.characterStream
2. LSOutput.byteStream
3. LSOutput.systemId

アプリケーションに所属する LSOutput オブジェクト。DOM 実装では、それらを変更することはありません (必要に応じて、コピーを作成して変更することは可能)。

「Document Object Model (DOM) Level 3 Load and Save Specification」も参照してください。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
OutputStream	getByteStream() 言語の属性と、書き込み可能なバイトのストリームを表すバインディング依存の型です。
Writer	getCharacterStream() 言語の属性と、16 ビット単位を出力できる書き込み可能なストリームを表すバインディング依存の型です。
String	getEncoding() 出力に使用される文字エンコーディング。
String	getSystemId() この出力先のシステム識別子、URI 参照「IETF RFC 2396」です。
void	setByteStream(OutputStream byteStream) 言語の属性と、書き込み可能なバイトのストリームを表すバインディング依存の型です。
void	setCharacterStream(Writer characterStream) 言語の属性と、16 ビット単位を出力できる書き込み可能なストリームを表すバインディング依存の型です。
void	setEncoding(String encoding) 出力に使用される文字エンコーディング。
void	setSystemId(String systemId) この出力先のシステム識別子、URI 参照「IETF RFC 2396」です。

メソッドの詳細

getCharacterStream

Writer getCharacterStream()

言語の属性と、16 ビット単位を出力できる書き込み可能なストリームを表すバインディング依存の型です。

setCharacterStream

void setCharacterStream(Writer characterStream)

言語の属性と、16 ビット単位を出力できる書き込み可能なストリームを表すバインディング依存の型です。

getByteStream

OutputStream getByteStream()

言語の属性と、書き込み可能なバイトのストリームを表すバインディング依存の型です。

setByteStream

void setByteStream(OutputStream byteStream)

言語の属性と、書き込み可能なバイトのストリームを表すバインディング依存の型です。

getSystemId

String getSystemId()

この出力先のシステム識別子、URI 参照「IETF RFC 2396」です。
システム ID が相対 URI 参照である場合 (「IETF RFC 2396」のセクション 5 を参照)、動作は実装依存です。

setSystemId

void setSystemId(String systemId)

この出力先のシステム識別子、URI 参照「IETF RFC 2396」です。
システム ID が相対 URI 参照である場合 (「IETF RFC 2396」のセクション 5 を参照)、動作は実装依存です。

getEncoding

String getEncoding()

出力に使用される文字エンコーディング。エンコーディングは、XML エンコーディング宣言 (「XML 1.0」セクション 4.3.3「エンティティーの文字エンコーディング」を参照) で受け入れ可能な文字列にする必要があります。Internet Assigned Numbers Authority「IANA-CHARSETS」に文字セットとして登録されている文字エンコーディングは、その登録名を使用して参照することをお勧めします。

setEncoding

void setEncoding(String encoding)

出力に使用される文字エンコーディング。エンコーディングは、XML エンコーディング宣言 (「XML 1.0」セクション 4.3.3「エンティティーの文字エンコーディング」を参照) で受け入れ可能な文字列にする必要があります。Internet Assigned Numbers Authority「IANA-CHARSETS」に文字セットとして登録されている文字エンコーディングは、その登録名を使用して参照することをお勧めします。