モジュール java.xml
パッケージ 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