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 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 を取得します。
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 が使用するシステム識別子。