Interface AsyncXMLStreamReader<F extends AsyncInputFeeder>

Type Parameters:
F - Type of input feeder used by reader; determines how input can be fed.
All Superinterfaces:
org.codehaus.stax2.typed.TypedXMLStreamReader, org.codehaus.stax2.validation.Validatable, XMLStreamConstants, XMLStreamReader, org.codehaus.stax2.XMLStreamReader2
All Known Implementing Classes:
AsyncStreamReaderImpl

public interface AsyncXMLStreamReader<F extends AsyncInputFeeder> extends org.codehaus.stax2.XMLStreamReader2
Extension of XMLStreamReader2 used by non-blocking ("async") stream readers. The main difference is addition of a token (EVENT_INCOMPLETE) to indicate that there is not yet enough content to parse to tokenize next event; and method to access AsyncInputFeeder that is used to provide input data in non-blocking manner.
  • Field Details

    • EVENT_INCOMPLETE

      static final int EVENT_INCOMPLETE
      As per javadocs of XMLStreamConstants, event codes 0 through 256 (inclusive?) are reserved by the Stax specs, so we'll use the next available code.
      See Also:
  • Method Details

    • getInputFeeder

      F getInputFeeder()
      Method used to access AsyncInputFeeder which is used to provide XML content to parse in non-blocking manner (see AsyncInputFeeder for more details).
      Returns:
      Input feeder to use for "pushing" content to parse.
    • getConfig

      ReaderConfig getConfig()