モジュール java.xml

パッケージ javax.xml.stream

インタフェースXMLEventWriter

すべてのスーパー・インタフェース:

XMLEventConsumer

public interface XMLEventWriter extends XMLEventConsumer

XML文書を書き込むための最上位のインタフェースです。 このインタフェースのインスタンスが、XMLの形式を検証する必要はありません。

導入されたバージョン:

1.6

関連項目:

• XMLEventReader
• XMLEvent
• Characters
• ProcessingInstruction
• StartElement
• EndElement

メソッドのサマリー

修飾子と型	メソッド	説明
void	add(XMLEvent event)	出力ストリームにイベントを追加します。START_ELEMENTを追加すると、新しい名前空間のスコープが開きます。これは、対応するEND_ELEMENTが書き込まれると閉じます。
void	add(XMLEventReader reader)	ストリーム全体を出力ストリームに追加し、hasNext()がfalseを返すまでinputStream引数でnext()を呼び出します。これは、イベント・リーダー内のすべてのイベントに対する後続のループを実行し、各イベントでaddを呼び出すための便利な方法として使用するようにします。
void	close()	このストリームに関連付けられているリソースをすべて解放します。
void	flush()	キャッシュに格納されたすべてのイベントを、ベースとなる出力メカニズムに書き込みます。
NamespaceContext	getNamespaceContext()	現在の名前空間コンテキストを返します。
String	getPrefix(String uri)	URIのバインド先の接頭辞を取得します。
void	setDefaultNamespace(String uri)	URIをデフォルトの名前空間にバインドします。このURIは、現在のSTART_ELEMENTとEND_ELEMENTのペアの範囲にバインドされます。
void	setNamespaceContext(NamespaceContext context)	接頭辞とURIのバインドに対して、現在の名前空間コンテキストを設定します。
void	setPrefix(String prefix, String uri)	URIのバインド先の接頭辞を設定します。

メソッドの詳細

flush

void flush() throws XMLStreamException

キャッシュに格納されたすべてのイベントを、ベースとなる出力メカニズムに書き込みます。

例外:

XMLStreamException - エラーが発生した場合

close

void close() throws XMLStreamException

このストリームに関連付けられているリソースをすべて解放します。

例外:

XMLStreamException - エラーが発生した場合

add

void add(XMLEvent event) throws XMLStreamException

出力ストリームにイベントを追加します。START_ELEMENTを追加すると、新しい名前空間のスコープが開きます。これは、対応するEND_ELEMENTが書き込まれると閉じます。

ライターに追加されるイベントの必須フィールドとオプション・フィールド

イベント・タイプ	必須フィールド	オプションのフィールド	必須の動作
START_ELEMENT	QName name	名前空間、属性	START_ELEMENTの書込みでは、イベントの名前、名前空間、および属性がXML 1.0の有効なSTART_ELEMENTの構文で書き込まれます。 名前は、名前空間URIの接頭辞を検索して書き込まれます。 ライターは、QNameの接頭辞に関係付けるように構成できます。 ライターを接頭辞に関係付ける場合は、QNameで接頭辞セットを使用する必要があります。 デフォルトの動作では、EventWriterの内部名前空間コンテキストで接頭辞の値が検索されます。 属性が存在する場合、各属性はこの表の属性のセクションで指定された動作を使用して書き込まれます。 名前空間が存在する場合、各名前空間はこの表の名前空間のセクションで指定された動作を使用して書き込まれます。
END_ELEMENT	Qname name	なし	整形式のEND_ELEMENTタグが書き込まれます。 名前は、名前空間URIの接頭辞を検索して書き込まれます。 ライターは、QNameの接頭辞に関係付けるように構成できます。 ライターを接頭辞に関係付ける場合は、QNameで接頭辞セットを使用する必要があります。 デフォルトの動作では、EventWriterの内部名前空間コンテキストで接頭辞の値が検索されます。 END_ELEMENTの名前がSTART_ELEMENTの名前に一致しない場合、XMLStreamExceptionがスローされます。
ATTRIBUTE	QName name、String value	QName type	START_ELEMENTで使用されるものと同じ字句形式検索アルゴリズムを使用して、属性が書き込まれます。 デフォルトでは、属性値を囲むために二重引用符が使用され、値内にある二重引用符をすべてエスケープします。 型の値は無視されます。
NAMESPACE	String prefix、String namespaceURI、boolean isDefaultNamespaceDeclaration	なし	名前空間宣言が書き込まれます。 名前空間がデフォルトの名前空間宣言(isDefaultがtrue)である場合、xmlns="$namespaceURI"が書き込まれ、接頭辞はオプションです。 isDefaultがfalseである場合、接頭辞を宣言する必要があり、ライターはxmlnsを接頭辞の前に付加し、標準の接頭辞宣言を書き出す必要があります。
PROCESSING_INSTRUCTION	なし	String target、String data	データが存在する必要はなく、nullでもかまいません。 ターゲットは必須で、null以外です。 ライターは適切なXML 1.0構文に従って、ターゲットの直後にデータ・セクションを書き込みます。
COMMENT	なし	String comment	コメントが存在する場合(null以外)、そのコメントが書き込まれます。存在しない場合は、空のコメントが書き込まれます。
START_DOCUMENT	なし	String encoding、boolean standalone、String version	START_DOCUMENTイベントをストリームに書き込む必要はありません。 属性が存在する場合、それらの属性は適切なXML宣言の構文で書き込まれます。
END_DOCUMENT	なし	なし	何も出力に書き込まれません。
DTD	String DocumentTypeDefinition	なし	DocumentTypeDefinitionが出力に書き込まれます。

定義:

add、インタフェースXMLEventConsumer

パラメータ:

event - 追加されるイベント

例外:

XMLStreamException - エラーが発生した場合

add

void add(XMLEventReader reader) throws XMLStreamException

ストリーム全体を出力ストリームに追加し、hasNext()がfalseを返すまでinputStream引数でnext()を呼び出します。これは、イベント・リーダー内のすべてのイベントに対する後続のループを実行し、各イベントでaddを呼び出すための便利な方法として使用するようにします。

パラメータ:

reader - 出力に追加するイベント・ストリーム

例外:

XMLStreamException - エラーが発生した場合

getPrefix

String getPrefix(String uri) throws XMLStreamException

URIのバインド先の接頭辞を取得します。

パラメータ:

uri - 検索するURI

戻り値:

プレフィクス

例外:

XMLStreamException - エラーが発生した場合

setPrefix

void setPrefix(String prefix, String uri) throws XMLStreamException

URIのバインド先の接頭辞を設定します。 この接頭辞は、現在のSTART_ELEMENTとEND_ELEMENTのペアの範囲にバインドされます。 START_ELEMENTが書き込まれる前にこのメソッドが呼び出されると、接頭辞はルートの範囲にバインドされます。

パラメータ:

prefix - URIにバインドされる接頭辞

uri - 接頭辞にバインドされるURI

例外:

XMLStreamException - エラーが発生した場合

setDefaultNamespace

void setDefaultNamespace(String uri) throws XMLStreamException

URIをデフォルトの名前空間にバインドします。このURIは、現在のSTART_ELEMENTとEND_ELEMENTのペアの範囲にバインドされます。 START_ELEMENTが書き込まれる前にこのメソッドが呼び出されると、URIはルートのスコープにバインドされます。

パラメータ:

uri - デフォルトの名前空間にバインドされるURI

例外:

XMLStreamException - エラーが発生した場合

setNamespaceContext

void setNamespaceContext(NamespaceContext context) throws XMLStreamException

接頭辞とURIのバインドに対して、現在の名前空間コンテキストを設定します。 このコンテキストは書込みに使用するルートの名前空間コンテキストになります。また、現在のルートの名前空間コンテキストを置き換えます。 後続のsetPrefixおよびsetDefaultNamespaceの呼出しでは、名前空間の解決用にルート・コンテキストとしてメソッドに渡されたコンテキストを使用して名前空間がバインドされます。

パラメータ:

context - このライターに使用する名前空間コンテキスト

例外:

XMLStreamException - エラーが発生した場合

getNamespaceContext

NamespaceContext getNamespaceContext()

現在の名前空間コンテキストを返します。

戻り値:

現在の名前空間コンテキスト