モジュール java.xml

パッケージ 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 final 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。