Top Description Fields Methods
com.fasterxml.aalto

public Interface AsyncXMLStreamReader<F extends com.fasterxml.aalto.AsyncInputFeeder>

extends XMLStreamReader2
Known Direct Implementers
com.fasterxml.aalto.async.AsyncStreamReaderImpl
Type Parameters
<F>
Type of input feeder used by reader; determines how input can be fed.
Imports
org.codehaus.stax2.XMLStreamReader2, com.fasterxml.aalto.in.ReaderConfig
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 Summary

Modifier and TypeField and Description
public static final int
EVENT_INCOMPLETE

As per javadocs of javax.xml.stream.XMLStreamConstants, event codes 0 through 256 (inclusive?) are reserved by the Stax specs, so we'll use the next available code.

Inherited from org.codehaus.stax2.XMLStreamReader2:
FEATURE_DTD_OVERRIDE

Method Summary

Modifier and TypeMethod and Description
public ReaderConfig
getConfig()

public F

Returns:

Input feeder to use for "pushing" content to parse.
getInputFeeder()

Method used to access AsyncInputFeeder which is used to provide XML content to parse in non-blocking manner (see AsyncInputFeeder for more details).

Inherited from org.codehaus.stax2.XMLStreamReader2:
closeCompletelygetAttributeInfogetDepthgetDTDInfogetFeaturegetLocationInfogetNonTransientNamespaceContextgetPrefixedNamegetTextisEmptyElementisPropertySupportedsetFeaturesetPropertyskipElement

Field Detail

EVENT_INCOMPLETEback to summary
public static final int EVENT_INCOMPLETE

As per javadocs of javax.xml.stream.XMLStreamConstants, event codes 0 through 256 (inclusive?) are reserved by the Stax specs, so we'll use the next available code.

Method Detail

getConfigback to summary
public ReaderConfig getConfig()
getInputFeederback to summary
public 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:F

Input feeder to use for "pushing" content to parse.