StreamSource (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.xml.transform.stream
クラス StreamSource

java.lang.Object
  javax.xml.transform.stream.StreamSource

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

public class StreamSource
extends Object
implements Source
extends Object
implements Source

XML マークアップのストリームの形式で変換 Source のホルダーとして動作します。

注 - Reader または InputStream インスタンスが内部使用されるため、StreamSource インスタンスが使用できるのは一度だけです。

フィールドの概要
`static String`	`FEATURE` この値を引数として渡したときに `TransformerFactory.getFeature(java.lang.String)` が true を返す場合、Transformer はこの型の Source 入力をサポートします。

コンストラクタの概要
`StreamSource()` 引数なしのデフォルトのコンストラクタです。
`StreamSource(File f)` File から StreamSource を構築します。
`StreamSource(InputStream inputStream)` バイトストリームから StreamSource を構築します。
`StreamSource(InputStream inputStream, String systemId)` バイトストリームから StreamSource を構築します。
`StreamSource(Reader reader)` 文字リーダから StreamSource を構築します。
`StreamSource(Reader reader, String systemId)` 文字リーダから StreamSource を構築します。
`StreamSource(String systemId)` URL から StreamSource を構築します。

メソッドの概要
`InputStream`	`getInputStream()` setByteStream を使って設定されたバイトストリームを取得します。
`String`	`getPublicId()` setPublicId を使って設定された公開識別子を取得します。
`Reader`	`getReader()` setReader を使って設定された文字ストリームを取得します。
`String`	`getSystemId()` setSystemId を使って設定されたシステム識別子を取得します。
`void`	`setInputStream(InputStream inputStream)` 入力として使用されるバイトストリームを設定します。
`void`	`setPublicId(String publicId)` この Source の公開識別子を設定します。
`void`	`setReader(Reader reader)` 文字リーダになる入力を構築します。
`void`	`setSystemId(File f)` File 参照からシステム識別子を設定します。
`void`	`setSystemId(String systemId)` この Source のシステム識別子を設定します。

クラス 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 はこの型の Source 入力をサポートします。

関連項目:: 定数フィールド値

コンストラクタの詳細

StreamSource

public StreamSource()

引数なしのデフォルトのコンストラクタです。このコンストラクタが使用されていて、setInputStream(java.io.InputStream inputStream) または setReader(java.io.Reader reader) を使用して設定された Stream ソースがない場合、Transformer は new InputStream() を使用して空のソース InputStream を作成します。

関連項目:: Transformer.transform(Source xmlSource, Result outputTarget)

StreamSource

public StreamSource(InputStream inputStream)

バイトストリームから StreamSource を構築します。通常、リーダでなくストリームを使用する必要があります。そうすれば、XML パーサは XML 宣言で指定された文字セットを解決することができます。

このコンストラクタを使用してスタイルシートを処理する場合、通常は、相対 URI 参照を解決できるように setSystemId も呼び出す必要があります。

パラメータ:: inputStream - XML ストリームへの有効な InputStream 参照

StreamSource

public StreamSource(InputStream inputStream,
                    String systemId)

このコンストラクタにより、入力ストリームに加えてシステム識別子を設定することができ、相対 URI を処理できるようになります。

パラメータ:: inputStream - XML ストリームへの有効な InputStream 参照; systemId - URI 構文に適合する String でなければならない

StreamSource

public StreamSource(Reader reader)

文字リーダから StreamSource を構築します。通常は、リーダでなくストリームを使用する必要があります。そうすれば、XML パーサは XML 宣言で指定された文字セットを解決することができます。ただし、StringReader から XML を読み込む場合のように、多くの場合、入力ストリームのエンコーディングはすでに解決されています。

パラメータ:: reader - XML 文字ストリームへの有効な Reader 参照

StreamSource

public StreamSource(Reader reader,
                    String systemId)

パラメータ:: reader - XML 文字ストリームへの有効な Reader 参照; systemId - URI 構文に適合する String でなければならない

StreamSource

public StreamSource(String systemId)

URL から StreamSource を構築します。

パラメータ:: systemId - URI 構文に適合する String でなければならない

StreamSource

public StreamSource(File f)

File から StreamSource を構築します。

パラメータ:: f - null 以外の File 参照でなければならない

メソッドの詳細

setInputStream

public void setInputStream(InputStream inputStream)

入力として使用されるバイトストリームを設定します。通常は、リーダでなくストリームを使用する必要があります。そうすれば、XML パーサは XML 宣言で指定された文字セットを解決することができます。

この Source オブジェクトを使用してスタイルシートを処理する場合、通常は、相対 URL 参照を解決できるように setSystemId も呼び出す必要があります。

パラメータ:: inputStream - XML ストリームへの有効な InputStream 参照

getInputStream

public InputStream getInputStream()

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

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

setReader

public void setReader(Reader reader)

文字リーダになる入力を構築します。通常は、リーダでなくストリームを使用する必要があります。そうすれば、XML パーサは XML 宣言で指定された文字セットを解決することができます。ただし、StringReader から XML を読み込む場合のように、多くの場合、入力ストリームのエンコーディングはすでに解決されています。

パラメータ:: reader - XML CharacterStream への有効な Reader 参照

getReader

public Reader getReader()

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

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

setPublicId

public void setPublicId(String publicId)

この Source の公開識別子を設定します。

公開識別子は常にオプションです。アプリケーションに公開識別子を含めたい場合は、位置情報の一部として指定します。

パラメータ:: publicId - 公開識別子を示す文字列

getPublicId

public String getPublicId()

setPublicId を使って設定された公開識別子を取得します。

戻り値:: setPublicId を使って設定された公開識別子。setPublicId が呼び出されなかった場合は null

setSystemId

public void setSystemId(String systemId)

この Source のシステム識別子を設定します。

バイトストリームまたは文字ストリームがある場合、システム識別子は省略可能ですが、指定した方が便利です。アプリケーションはそれを使用して相対 URI を解決し、エラーメッセージや警告に含めることができるためです。パーサは、バイトストリームまたは文字ストリームが指定されていない場合にかぎり、URI への接続を開こうとします。