モジュール java.xml

パッケージ javax.xml.transform.stream

クラスStreamResult

java.lang.Object

javax.xml.transform.stream.StreamResult

すべての実装されたインタフェース:

Result

public class StreamResult extends Object implements Result

XML、プレーンText、HTML、その他のマークアップ形式の、変換結果のホルダーとして動作します。

導入されたバージョン:

1.4

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final String	FEATURE	この値を引数として渡したときにTransformerFactory.getFeature(java.lang.String)がtrueを返す場合、Transformerはこの型のResult出力をサポートします。

インタフェースjavax.xml.transform.Resultで宣言されているフィールド

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
StreamResult()	デフォルトの引数なしのコンストラクタ。
StreamResult(File f)	FileからStreamResultを構築します。
StreamResult(OutputStream outputStream)	バイト・ストリームからStreamResultを構築します。
StreamResult(Writer writer)	文字ストリームからStreamResultを構築します。
StreamResult(String systemId)	URLからStreamResultを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
OutputStream	getOutputStream()	setOutputStreamを使って設定されたバイト・ストリームを取得します。
String	getSystemId()	setSystemIdを使って設定されたシステム識別子を取得します。
Writer	getWriter()	setWriterを使って設定された文字ストリームを取得します。
void	setOutputStream(OutputStream outputStream)	書込み先のByteStreamを設定します。
void	setSystemId(File f)	File参照からシステムIDを設定します。
void	setSystemId(String systemId)	バイトまたは文字ストリームと関連付けて使用できるシステム識別子を設定します。どちらも設定されない場合は、この値を書込み可能なURI (おそらく、ファイル名)として使用します。
void	setWriter(Writer writer)	結果を受け取るライターを設定します。

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールド詳細

FEATURE

public static final String FEATURE

この値を引数として渡したときにTransformerFactory.getFeature(java.lang.String)がtrueを返す場合、Transformerはこの型のResult出力をサポートします。

関連項目:

• 定数フィールド値

コンストラクタの詳細

StreamResult

public StreamResult()

デフォルトの引数なしのコンストラクタ。

StreamResult

public StreamResult(OutputStream outputStream)

バイト・ストリームからStreamResultを構築します。 通常は、リーダーでなくストリームを使用する必要があります。そうすれば、Transformerは変換命令に含まれる命令を使用してエンコーディングを制御できます。

パラメータ:

outputStream - 有効なOutputStream参照。

StreamResult

public StreamResult(Writer writer)

文字ストリームからStreamResultを構築します。 通常は、リーダーでなくストリームを使用する必要があります。そうすれば、Transformerは変換命令に含まれる命令を使用してエンコーディングを制御できます。 ただし、StringWriterを使用する場合のように、文字ストリームに書き込むのが便利な場合があります。

パラメータ:

writer - 有効なWriter参照。

StreamResult

public StreamResult(String systemId)

URLからStreamResultを構築します。

パラメータ:

systemId - URI構文に適合するStringでなければならない。

StreamResult

public StreamResult(File f)

FileからStreamResultを構築します。

パラメータ:

f - null以外のFile参照でなければならない。

メソッドの詳細

setOutputStream

public void setOutputStream(OutputStream outputStream)

書込み先のByteStreamを設定します。 通常は、リーダーでなくストリームを使用する必要があります。そうすれば、Transformerは変換命令に含まれる命令を使用してエンコーディングを制御できます。

パラメータ:

outputStream - 有効なOutputStream参照。

getOutputStream

public OutputStream getOutputStream()

setOutputStreamを使って設定されたバイト・ストリームを取得します。

戻り値:

setOutputStreamを使って設定されたバイト・ストリーム。setOutputStreamまたはByteStreamコンストラクタが呼び出されなかった場合はnull。

setWriter

public void setWriter(Writer writer)

結果を受け取るライターを設定します。 通常は、ライターでなくストリームを使用する必要があります。そうすれば、Transformerは変換命令に含まれる命令を使用してエンコーディングを制御できます。 ただし、StringWriterを使用する場合のように、ライターに書き込むのが便利な場合があります。

パラメータ:

writer - 有効なWriter参照。

getWriter

public Writer getWriter()

setWriterを使って設定された文字ストリームを取得します。

戻り値:

setWriterを使って設定された文字ストリーム。setWriterまたはWriterコンストラクタが呼び出されなかった場合はnull。

setSystemId

public void setSystemId(String systemId)

バイトまたは文字ストリームと関連付けて使用できるシステム識別子を設定します。どちらも設定されない場合は、この値を書込み可能なURI (おそらく、ファイル名)として使用します。

定義:

setSystemId、インタフェースResult

パラメータ:

systemId - URI文字列としてのシステム識別子。

setSystemId

public void setSystemId(File f)

File参照からシステムIDを設定します。

パラメータ:

f - null以外のFile参照でなければならない。

getSystemId

public String getSystemId()

setSystemIdを使って設定されたシステム識別子を取得します。

定義:

getSystemId、インタフェースResult

戻り値:

setSystemIdを使用して設定されたシステム識別子。setSystemIdが呼び出されなかった場合はnull。