javax.xml.transform.stax

クラス StAXResult

java.lang.Object

javax.xml.transform.stax.StAXResult

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

Result

public class StAXResult
extends Object
implements Result

StAX ライター XMLStreamWriter または XMLEventWriter の形式の XML Result のホルダーとして機能します。StAXResult は、Result を受け入れるすべてのケース、たとえば Transformer や、入力として Result を受け入れる Validator で使用できます。

導入されたバージョン:

1.6

関連項目:

JSR 173:Streaming API for XML, XMLStreamWriter, XMLEventWriter

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	FEATURE この値を引数として渡したときに TransformerFactory.getFeature(String name) が true を返す場合、Transformer はこの型の Result 出力をサポートします。

インタフェース javax.xml.transform.Result から継承されたフィールド

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

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

コンストラクタ

コンストラクタと説明
StAXResult(XMLEventWriter xmlEventWriter) XMLEventWriter を指定して、StAXResult の新しいインスタンスを作成します。
StAXResult(XMLStreamWriter xmlStreamWriter) XMLStreamWriter を指定して、StAXResult の新しいインスタンスを作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getSystemId() 返されるシステム識別子は常に null。
XMLEventWriter	getXMLEventWriter() この StAXResult が使用する XMLEventWriter を取得します。
XMLStreamWriter	getXMLStreamWriter() この StAXResult が使用する XMLStreamWriter を取得します。
void	setSystemId(String systemId) StAXResult のコンテキストでは、システム識別子を明示的に設定することは適切ではありません。

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

関連項目:

定数フィールド値

コンストラクタの詳細

StAXResult

public StAXResult(XMLEventWriter xmlEventWriter)

XMLEventWriter を指定して、StAXResult の新しいインスタンスを作成します。

XMLEventWriter は null でない参照である必要があります。

パラメータ:

xmlEventWriter - この StAXResult の作成に使われる XMLEventWriter。

例外:

IllegalArgumentException - xmlEventWriter == null の場合。

StAXResult

public StAXResult(XMLStreamWriter xmlStreamWriter)

XMLStreamWriter を指定して、StAXResult の新しいインスタンスを作成します。

XMLStreamWriter は null でない参照である必要があります。

パラメータ:

xmlStreamWriter - この StAXResult の作成に使われる XMLStreamWriter。

例外:

IllegalArgumentException - xmlStreamWriter == null の場合。

メソッドの詳細

getXMLEventWriter

public XMLEventWriter getXMLEventWriter()

この StAXResult が使用する XMLEventWriter を取得します。

この StAXResult が XMLStreamWriter に基づいて作成された場合、XMLEventWriter は null になります。

戻り値:

この StAXResult が使用する XMLEventWriter。

getXMLStreamWriter

public XMLStreamWriter getXMLStreamWriter()

この StAXResult が使用する XMLStreamWriter を取得します。

この StAXResult が XMLEventWriter に基づいて作成された場合、XMLStreamWriter は null になります。

戻り値:

この StAXResult が使用する XMLStreamWriter。

setSystemId

public void setSystemId(String systemId)

StAXResult のコンテキストでは、システム識別子を明示的に設定することは適切ではありません。XML 結果のシステム識別子は、この StAXResult の構築に使用された XMLEventWriter または XMLStreamWriter によって決定されます。

UnsupportedOperationException は常にこのメソッドによってスローされます。

定義:

setSystemId、インタフェース: Result

パラメータ:

systemId - 無視される。

例外:

UnsupportedOperationException - 常にこのメソッドによってスローされる。

getSystemId

public String getSystemId()

返されるシステム識別子は常に null。

定義:

getSystemId、インタフェース: Result

戻り値:

返されるシステム識別子は常に null。