共通 DOM API

org.w3c.dom.ls
インタフェース LSOutput


public interface LSOutput

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

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

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

アプリケーションは、このインタフェースを実装するオブジェクトが必要な場合はいつでもこのようなオブジェクトを提供することが期待されます。アプリケーションは、このインタフェースを実装する独自のオブジェクトを提供するか、DOMImplementationLS.createLSOutput() 汎用ファクトリメソッドを使って、このインタフェースを実装するオブジェクトを生成できます。

LSSerializerLSOutput オブジェクトを使って出力を直列化する場所を判定します。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 項「Character Encoding in Entities」) で受け入れ可能な文字列でなければなりません。Internet Assigned Numbers Authority [IANA-CHARSETS] を通じて文字セットとして登録された文字エンコーディングは、登録名を使って参照することを推奨します。


setEncoding

void setEncoding(String encoding)
出力に使用する文字エンコーディング。エンコーディングはXML エンコーディング宣言 ([XML 1.0] の 4.3.3 項「Character Encoding in Entities」) で受け入れ可能な文字列でなければなりません。Internet Assigned Numbers Authority [IANA-CHARSETS] を通じて文字セットとして登録された文字エンコーディングは、登録名を使って参照することを推奨します。


共通 DOM API

バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 2004 Sun Microsystems, Inc. 4150 Network Circle
Santa Clara, California, 95054, U.S.A. All Rights Reserved.