モジュール java.xml
パッケージ javax.xml.transform.stream

クラスStreamSource

java.lang.Object
javax.xml.transform.stream.StreamSource
すべての実装されたインタフェース:
Source
public class StreamSource
extends Object
implements Source

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

ノート: ReaderまたはInputStreamインスタンスの内部使用により、StreamSourceインスタンスは1回のみ使用できます。

導入されたバージョン:
1.4

  • フィールドのサマリー

    フィールド
    修飾子と型 フィールド 説明
    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を使って設定されたシステム識別子を取得します。
    boolean isEmpty()
    StreamSourceオブジェクトが空であるかどうかを示します。
    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

  • フィールド詳細

  • コンストラクタの詳細

    • 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)
      バイト・ストリームからStreamSourceを構築します。 通常は、リーダーでなくストリームを使用する必要があります。そうすれば、XMLパーサーはXML宣言で指定された文字エンコーディングを解決できます。

      このコンストラクタにより、入力ストリームに加えてシステム識別子を設定することができ、相対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)
      文字リーダーからStreamSourceを構築します。 通常は、リーダーでなくストリームを使用する必要があります。そうすれば、XMLパーサーはXML宣言で指定された文字エンコーディングを解決できます。 ただし、StringReaderからXMLを読み取る場合のように、多くの場合、入力ストリームのエンコーディングはすでに解決されています。
      パラメータ:
      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への接続を開こうとします。

      定義:
      setSystemId、インタフェース: Source
      パラメータ:
      systemId - URL文字列としてのシステム識別子。

    • getSystemId

      public String getSystemId()
      setSystemIdを使って設定されたシステム識別子を取得します。
      定義:
      getSystemId、インタフェース: Source
      戻り値:
      setSystemIdを使用して設定されたシステム識別子。setSystemIdが呼び出されなかった場合はnull。

    • setSystemId

      public void setSystemId​(File f)
      File参照からシステム識別子を設定します。
      パラメータ:
      f - null以外のFile参照でなければならない。

    • isEmpty

      public boolean isEmpty()
      StreamSourceオブジェクトが空であるかどうかを示します。 空は次のように定義されます:
      • 公開識別子、システム識別子、バイト・ストリーム、文字ストリームなど、すべての入力ソースはnullです。
      • 公開識別子およびシステム識別子はnullであり、バイトおよび文字ストリームはnullであるか、バイトまたは文字を含みません。

        このメソッドは、指定されている場合はバイト・ストリームをリセットし、バイト・ストリームが提供されていない場合は文字ストリームをリセットします。

      バイトまたは文字ストリームのチェック中にエラーが発生した場合、メソッドはfalseを返して、XMLプロセッサがエラーを処理できるようにします。

      定義:
      インタフェースSource内のisEmpty
      戻り値:
      StreamSourceオブジェクトが空の場合はtrue、そうでない場合はfalse