Package org.springframework.batch.item.xml.stax

# Interface FragmentEventReader

All Superinterfaces:
  `Iterator<Object>`, `XMLEventReader`

All Known Implementing Classes:
  `DefaultFragmentEventReader`

public interface FragmentEventReader extends XMLEventReader
Interface for event readers which support treating XML fragments as standalone XML documents by wrapping the fragments with StartDocument and EndDocument events.

Author:
  Robert Kasanicky

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `markFragmentProcessed()`
  Tells the event reader the current fragment has been processed.
  `void`
  `markStartFragment()`
  Tells the event reader its cursor position is exactly before the fragment.
  `void`
  `reset()`
  Reset the state of the fragment reader - make it forget it assumptions about current position of cursor (e.g.

  ### Methods inherited from interface java.util.Iterator

  `forEachRemaining, next, remove`

  ### Methods inherited from interface javax.xml.stream.XMLEventReader

  `close, getElementText, getProperty, hasNext, nextEvent, nextTag, peek`

- ## Method Details

  - ### markStartFragment

    void markStartFragment()
    Tells the event reader its cursor position is exactly before the fragment.

  - ### markFragmentProcessed

    void markFragmentProcessed()
    Tells the event reader the current fragment has been processed. If the cursor is still inside the fragment it should be moved after the end of the fragment.

  - ### reset

    void reset()
    Reset the state of the fragment reader - make it forget it assumptions about current position of cursor (e.g. in case of rollback of the wrapped reader).