モジュール java.xml

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

クラスStAXSource

java.lang.Object

javax.xml.transform.stax.StAXSource

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

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 final String	FEATURE	この値を引数として渡したときにTransformerFactory.getFeature(String name)がtrueを返す場合、Transformerはこの型のSource入力をサポートします。

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

コンストラクタ

コンストラクタ	説明
StAXSource(XMLEventReader xmlEventReader)	XMLEventReaderを指定して、StAXSourceの新しいインスタンスを作成します。
StAXSource(XMLStreamReader xmlStreamReader)	XMLStreamReaderを指定して、StAXSourceの新しいインスタンスを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
String	getSystemId()	このStAXSourceが使用するシステム識別子を取得します。
XMLEventReader	getXMLEventReader()	このStAXSourceが使用するXMLEventReaderを取得します。
XMLStreamReader	getXMLStreamReader()	このStAXSourceが使用するXMLStreamReaderを取得します。
boolean	isEmpty()	StAXSourceオブジェクトが空かどうかを示します。
void	setSystemId(String systemId)	StAXSourceのコンテキストでは、システム識別子を明示的に設定することは適切ではありません。

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

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

フィールド詳細

FEATURE

public static final String FEATURE

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

関連項目:

• 定数フィールド値

コンストラクタの詳細

StAXSource

public StAXSource(XMLEventReader xmlEventReader) throws XMLStreamException

XMLEventReaderを指定して、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を返します。

定義:

インタフェースSource内のisEmpty

戻り値:

無条件に偽