javax.xml.stream.util
インタフェース XMLEventAllocator

public interface XMLEventAllocator

このインタフェースは、指定されたイベントに XMLStreamReader を割り当てる方法をユーザーが登録できるようにするためのクラスを定義します。XMLEventFactory 実装を使用するための実装は必須ではありませんが、そのようにすることが推奨されています。XMLEventAllocator は、javax.xml.stream.allocator プロパティーを使用して XMLInputFactory で設定できます。

導入されたバージョン:

1.6

関連項目:

XMLInputFactory, XMLEventFactory

メソッドの概要

XMLEvent	allocate(XMLStreamReader reader) このメソッドは、指定されたイベントに XMLStreamReader の現在の状態を割り当てます。
void	allocate(XMLStreamReader reader, XMLEventConsumer consumer) このメソッドは、指定されたイベントまたはイベントセットに XMLStreamReader の現在の状態を割り当て、渡されたコンシューマにそのイベントまたはイベントセットを追加します。
XMLEventAllocator	newInstance() このメソッドは、XMLEventAllocator のインスタンスを作成します。

メソッドの詳細

newInstance

XMLEventAllocator newInstance()

このメソッドは、XMLEventAllocator のインスタンスを作成します。これを利用して、XMLInputFactory はリーダーごとに新しいインスタンスを割り当てることができます。

allocate

XMLEvent allocate(XMLStreamReader reader)
                  throws XMLStreamException

このメソッドは、指定されたイベントに XMLStreamReader の現在の状態を割り当てます。この XMLEventAllocator がリーダーの状態とイベントの間に 1 対 1 の対応関係を持たない場合、このメソッドは null を返します。このメソッドが XMLStreamReader の状態を変更することはありません。

パラメータ:

reader - 割り当て元の XMLStreamReader

戻り値:

現在のリーダーの状態に対応するイベント

例外:

XMLStreamException

allocate

void allocate(XMLStreamReader reader,
              XMLEventConsumer consumer)
              throws XMLStreamException

このメソッドは、指定されたイベントまたはイベントセットに XMLStreamReader の現在の状態を割り当て、渡されたコンシューマにそのイベントまたはイベントセットを追加します。このメソッドを使用して、リーダーの状態をイベントの状態に拡張または縮小できます。このメソッドは XMLStreamReader の状態を変更することがあります。

パラメータ:

reader - 割り当て元の XMLStreamReader

consumer - 追加先の XMLEventConsumer

例外:

XMLStreamException