- すべての実装されたインタフェース:
Source
public class StAXSource extends Object implements Source
StAXリーダーXMLStreamReaderまたはXMLEventReaderの形式のXML Sourceのホルダーとして機能します。 StAXSourceは、Sourceを受け入れるすべてのケース、たとえばTransformerや、入力としてSourceを受け入れるValidatorで使用できます。
StAXSourceは処理中に消費されます。再利用はできません。
- 導入されたバージョン:
- 1.6
- 関連項目:
- JSR 173:Streaming API for XML,
XMLStreamReader,XMLEventReader
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static StringFEATUREこの値を引数として渡したときにTransformerFactory.getFeature(String name)がtrueを返す場合、Transformerはこの型のSource入力をサポートします。 -
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 StAXSource(XMLEventReader xmlEventReader)XMLEventReaderを指定して、StAXSourceの新しいインスタンスを作成します。StAXSource(XMLStreamReader xmlStreamReader)XMLStreamReaderを指定して、StAXSourceの新しいインスタンスを作成します。 -
メソッドのサマリー
修飾子と型 メソッド 説明 StringgetSystemId()このStAXSourceが使用するシステム識別子を取得します。XMLEventReadergetXMLEventReader()このStAXSourceが使用するXMLEventReaderを取得します。XMLStreamReadergetXMLStreamReader()このStAXSourceが使用するXMLStreamReaderを取得します。booleanisEmpty()StAXSourceオブジェクトが空であるかどうかを示します。voidsetSystemId(String systemId)StAXSourceのコンテキストでは、システム識別子を明示的に設定することは適切ではありません。
-
フィールド詳細
-
FEATURE
public static final String FEATUREこの値を引数として渡したときにTransformerFactory.getFeature(String name)がtrueを返す場合、Transformerはこの型のSource入力をサポートします。- 関連項目:
- 定数フィールド値
-
-
コンストラクタの詳細
-
StAXSource
public StAXSource(XMLEventReader xmlEventReader) throws XMLStreamExceptionXMLEventReaderを指定して、StAXSourceの新しいインスタンスを作成します。XMLEventReaderはnullでない参照である必要があります。XMLEventReaderはXMLStreamConstants.START_DOCUMENTまたはXMLStreamConstants.START_ELEMENT状態である必要があります。- パラメータ:
xmlEventReader- このStAXSourceの作成に使われるXMLEventReader。- 例外:
XMLStreamException-xmlEventReaderアクセスがExceptionをスローする場合。IllegalArgumentException-xmlEventReader==nullの場合。IllegalStateException-xmlEventReaderがXMLStreamConstants.START_DOCUMENTまたはXMLStreamConstants.START_ELEMENT状態でない場合。
-
StAXSource
public StAXSource(XMLStreamReader xmlStreamReader)XMLStreamReaderを指定して、StAXSourceの新しいインスタンスを作成します。XMLStreamReaderはnullでない参照である必要があります。XMLStreamReaderはXMLStreamConstants.START_DOCUMENTまたはXMLStreamConstants.START_ELEMENT状態である必要があります。- パラメータ:
xmlStreamReader- このStAXSourceの作成に使われるXMLStreamReader。- 例外:
IllegalArgumentException-xmlStreamReader==nullの場合。IllegalStateException-xmlStreamReaderがXMLStreamConstants.START_DOCUMENTまたはXMLStreamConstants.START_ELEMENT状態でない場合。
-
-
メソッドの詳細
-
getXMLEventReader
public XMLEventReader getXMLEventReader()この
StAXSourceが使用するXMLEventReaderを取得します。この
StAXSourceがXMLStreamReaderに基づいて作成された場合、XMLEventReaderはnullになります。- 戻り値:
- この
StAXSourceが使用するXMLEventReader。
-
getXMLStreamReader
public XMLStreamReader getXMLStreamReader()この
StAXSourceが使用するXMLStreamReaderを取得します。この
StAXSourceがXMLEventReaderに基づいて作成された場合、XMLStreamReaderはnullになります。- 戻り値:
- この
StAXSourceが使用するXMLStreamReader。
-
setSystemId
public void setSystemId(String systemId)StAXSourceのコンテキストでは、システム識別子を明示的に設定することは適切ではありません。 XMLソースのシステム識別子は、このStAXSourceの構築に使用されたXMLStreamReaderまたはXMLEventReaderによって決定されます。UnsupportedOperationExceptionは常にこのメソッドによってスローされます。- 定義:
setSystemId、インタフェース:Source- パラメータ:
systemId- 無視される。- 例外:
UnsupportedOperationException- 常にこのメソッドによってスローされる。
-
getSystemId
public String getSystemId()この
StAXSourceが使用するシステム識別子を取得します。XMLソースのシステム識別子を決定する際は、この
StAXSourceの構築に使用されたXMLStreamReaderまたはXMLEventReaderが照会されます。システム識別子は
nullか、空の""Stringである可能性があります。- 定義:
getSystemId、インタフェース:Source- 戻り値:
- この
StAXSourceが使用するシステム識別子。
-
isEmpty
public boolean isEmpty()StAXSourceオブジェクトが空であるかどうかを示します。StAXSourceオブジェクトは決して空ではないので、このメソッドは常にfalseを返します。
-