com.fasterxml.aalto.async
Class AsyncUtfScanner

java.lang.Object
  com.fasterxml.aalto.in.XmlScanner
      com.fasterxml.aalto.in.ByteBasedScanner
          com.fasterxml.aalto.async.AsyncByteScanner
              com.fasterxml.aalto.async.AsyncUtfScanner

All Implemented Interfaces:

XmlConsts, javax.xml.namespace.NamespaceContext, javax.xml.stream.XMLStreamConstants

public class AsyncUtfScanner
extends AsyncByteScanner

This class handles parsing of UTF-8 encoded xml streams, as well as other UTF-8 compatible (subset) encodings (specifically, Latin1 and US-Ascii).

Field Summary

Fields inherited from class com.fasterxml.aalto.async.AsyncByteScanner

_currQuad, _currQuadBytes, _inputBuffer, EVENT_INCOMPLETE, mElemAllNsBound, mElemAttrCount, mElemAttrName, mElemAttrPtr, mElemAttrQuote, mNextEvent, mOrigBufferLen, mPendingInput, mQuadCount, mState, mSurroundingEvent

Fields inherited from class com.fasterxml.aalto.in.ByteBasedScanner

_inputEnd, _inputPtr, BYTE_a, BYTE_A, BYTE_AMP, BYTE_APOS, BYTE_C, BYTE_CR, BYTE_D, BYTE_EQ, BYTE_EXCL, BYTE_g, BYTE_GT, BYTE_HASH, BYTE_HYPHEN, BYTE_l, BYTE_LBRACKET, BYTE_LF, BYTE_LT, BYTE_m, BYTE_NULL, BYTE_o, BYTE_p, BYTE_P, BYTE_q, BYTE_QMARK, BYTE_QUOT, BYTE_RBRACKET, BYTE_s, BYTE_S, BYTE_SEMICOLON, BYTE_SLASH, BYTE_SPACE, BYTE_t, BYTE_T, BYTE_TAB, BYTE_u, BYTE_x, mCharTypes, mPastBytes, mQuadBuffer, mRowStartOffset, mSymbols, mTmpChar

Fields inherited from class com.fasterxml.aalto.in.XmlScanner

_attrCollector, _attrCount, _cfgCoalescing, _cfgLazyParsing, _config, _currElem, _currNsCount, _currRow, _currToken, _defaultNs, _depth, _entityPending, _isEmptyTag, _lastNsContext, _lastNsDecl, _nameBuffer, _publicId, _systemId, _textBuilder, _tokenIncomplete, _tokenName, _xml11, CDATA_STR, INT_A, INT_AMP, INT_APOS, INT_COLON, INT_CR, INT_EQ, INT_EXCL, INT_GT, INT_HYPHEN, INT_LBRACKET, INT_LF, INT_LT, INT_NULL, INT_QMARK, INT_QUOTE, INT_RBRACKET, INT_SLASH, INT_SPACE, INT_TAB, MAX_UNICODE_CHAR, TOKEN_EOI

Fields inherited from interface com.fasterxml.aalto.XmlConsts

CHAR_CR, CHAR_LF, CHAR_NULL, CHAR_SPACE, STAX_DEFAULT_OUTPUT_ENCODING, STAX_DEFAULT_OUTPUT_VERSION, XML_DECL_KW_ENCODING, XML_DECL_KW_STANDALONE, XML_DECL_KW_VERSION, XML_SA_NO, XML_SA_YES, XML_V_10, XML_V_10_STR, XML_V_11, XML_V_11_STR, XML_V_UNKNOWN

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

AsyncUtfScanner(ReaderConfig cfg)

Method Summary

protected PName	addPName(int hash, int[] quads, int qlen, int lastQuadBytes)
protected int	decodeUtf8_2(int c) Note: caller must guarantee enough data is available before calling the method
protected int	decodeUtf8_3(int c1) Note: caller must guarantee enough data is available before calling the method
protected int	decodeUtf8_3(int c1, int c2, int c3)
protected int	decodeUtf8_4(int c)
protected int	decodeUtf8_4(int c1, int c2, int c3, int c4)
protected void	finishCharacters() This method only gets called in non-coalescing mode; and if so, needs to parse as many characters of the current text segment from the current input block as possible.
protected int	finishCharactersCoalescing()
protected boolean	handleAttrValue()
protected int	handleCommentPending()
protected boolean	handleNsDecl()
protected int	handlePIPending()
protected int	parseCommentContents()
protected int	parsePIData()
protected void	reportInvalidInitial(int mask)
protected void	reportInvalidOther(int mask)
protected void	reportInvalidOther(int mask, int ptr)
protected boolean	skipCharacters() Method that will be called to skip all possible characters from the input buffer, but without blocking.
protected boolean	skipCoalescedText() Coalescing mode is (and will) not be implemented for non-blocking parsers, so this method should never get called.
protected void	skipUtf8_2(int c)
protected int	startCharacters(byte b) Method called to initialize state for CHARACTERS event, after just a single byte has been seen.
protected int	startCharactersPending() This method gets called, if the first character of a CHARACTERS event could not be fully read (multi-byte, split over buffer boundary).

Methods inherited from class com.fasterxml.aalto.async.AsyncByteScanner

_closeSource, addInput, decodeCharForError, finishCData, finishComment, finishDTD, finishPI, finishSpace, handleCharacterEntity, handleEntity, handleEntityStart, handleGeneralEntity, handlePartialCR, handleStartElement, handleStartElementStart, hasInput, loadMore, nextFromProlog, nextFromTree, parseEntityName, parseNewEntityName, parseNewName, parsePName, skipCData, skipComment, skipPI, skipSpace, throwInternal, toString

Methods inherited from class com.fasterxml.aalto.in.ByteBasedScanner

_releaseBuffers, addUtfPName, getCurrentColumnNr, getCurrentLineNr, getCurrentLocation, markLF, markLF

Methods inherited from class com.fasterxml.aalto.in.XmlScanner

bindName, bindNs, checkImmutableBinding, close, decodeAttrBinaryValue, decodeAttrValue, decodeAttrValues, findAttrIndex, findOrCreateBinding, finishToken, fireSaxCharacterEvents, fireSaxCommentEvent, fireSaxEndElement, fireSaxPIEvent, fireSaxSpaceEvents, fireSaxStartElement, getAttrCollector, getAttrCount, getAttrLocalName, getAttrNsURI, getAttrPrefix, getAttrPrefixedName, getAttrQName, getAttrType, getAttrValue, getAttrValue, getConfig, getDepth, getDtdPublicId, getDtdSystemId, getEndLocation, getInputPublicId, getInputSystemId, getName, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getNonTransientNamespaceContext, getNsCount, getPrefix, getPrefixes, getQName, getStartLocation, getText, getText, getTextCharacters, getTextCharacters, getTextLength, hasEmptyStack, isAttrSpecified, isEmptyTag, isTextWhitespace, loadMoreGuaranteed, loadMoreGuaranteed, reportDoubleHyphenInComments, reportDuplicateNsDecl, reportEntityOverflow, reportEofInName, reportIllegalCDataEnd, reportIllegalNsDecl, reportIllegalNsDecl, reportInputProblem, reportInvalidNameChar, reportInvalidNsIndex, reportInvalidXmlChar, reportMissingPISpace, reportMultipleColonsInName, reportPrologUnexpChar, reportTreeUnexpChar, reportUnboundPrefix, reportUnexpandedEntityInAttr, reportUnexpectedEndTag, skipToken, throwInvalidSpace, throwInvalidXmlChar, throwNullChar, throwUnexpectedChar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AsyncUtfScanner

public AsyncUtfScanner(ReaderConfig cfg)

Method Detail

startCharacters

protected final int startCharacters(byte b)
                             throws javax.xml.stream.XMLStreamException

Description copied from class: AsyncByteScanner

Method called to initialize state for CHARACTERS event, after just a single byte has been seen. What needs to be done next depends on whether coalescing mode is set or not: if it is not set, just a single character needs to be decoded, after which current event will be incomplete, but defined as CHARACTERS. In coalescing mode, the whole content must be read before current event can be defined. The reason for difference is that when XMLStreamReader.next() returns, no blocking can occur when calling other methods.

Specified by:

startCharacters in class AsyncByteScanner

Returns:

Event type detected; either CHARACTERS, if at least one full character was decoded (and can be returned), EVENT_INCOMPLETE if not (part of a multi-byte character split across input buffer boundary)

Throws:

javax.xml.stream.XMLStreamException

startCharactersPending

protected int startCharactersPending()
                              throws javax.xml.stream.XMLStreamException

Description copied from class: AsyncByteScanner

This method gets called, if the first character of a CHARACTERS event could not be fully read (multi-byte, split over buffer boundary). If so, there is some pending data to be handled.

Specified by:

startCharactersPending in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

finishCharacters

protected final void finishCharacters()
                               throws javax.xml.stream.XMLStreamException

This method only gets called in non-coalescing mode; and if so, needs to parse as many characters of the current text segment from the current input block as possible.

Specified by:

finishCharacters in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

finishCharactersCoalescing

protected final int finishCharactersCoalescing()
                                        throws javax.xml.stream.XMLStreamException

Specified by:

finishCharactersCoalescing in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

skipCharacters

protected boolean skipCharacters()
                          throws javax.xml.stream.XMLStreamException

Method that will be called to skip all possible characters from the input buffer, but without blocking. Partial characters are not to be handled (not pending input is to be added).

Specified by:

skipCharacters in class AsyncByteScanner

Returns:

True, if skipping ending with an unexpanded entity; false if not

Throws:

javax.xml.stream.XMLStreamException

skipCoalescedText

protected boolean skipCoalescedText()
                             throws javax.xml.stream.XMLStreamException

Coalescing mode is (and will) not be implemented for non-blocking parsers, so this method should never get called.

Specified by:

skipCoalescedText in class XmlScanner

Returns:

True, if an unexpanded entity was encountered (and is now pending)

Throws:

javax.xml.stream.XMLStreamException

handleAttrValue

protected boolean handleAttrValue()
                           throws javax.xml.stream.XMLStreamException

Specified by:

handleAttrValue in class AsyncByteScanner

Returns:

True, if the whole value was read; false if only part (due to buffer ending)

Throws:

javax.xml.stream.XMLStreamException

handleNsDecl

protected boolean handleNsDecl()
                        throws javax.xml.stream.XMLStreamException

Specified by:

handleNsDecl in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

parseCommentContents

protected final int parseCommentContents()
                                  throws javax.xml.stream.XMLStreamException

Specified by:

parseCommentContents in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

handleCommentPending

protected final int handleCommentPending()
                                  throws javax.xml.stream.XMLStreamException

Returns:

EVENT_INCOMPLETE, if there's not enough input to handle pending char, COMMENT, if we handled complete "-->" end marker, or 0 to indicate something else was succesfully handled.

Throws:

javax.xml.stream.XMLStreamException

parsePIData

protected final int parsePIData()
                         throws javax.xml.stream.XMLStreamException

Specified by:

parsePIData in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

handlePIPending

protected final int handlePIPending()
                             throws javax.xml.stream.XMLStreamException

Returns:

EVENT_INCOMPLETE, if there's not enough input to handle pending char, PROCESSING_INSTRUCTION, if we handled complete "?>" end marker, or 0 to indicate something else was succesfully handled.

Throws:

javax.xml.stream.XMLStreamException

decodeUtf8_2

protected final int decodeUtf8_2(int c)
                          throws javax.xml.stream.XMLStreamException

Note: caller must guarantee enough data is available before calling the method

Throws:

javax.xml.stream.XMLStreamException

skipUtf8_2

protected final void skipUtf8_2(int c)
                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

decodeUtf8_3

protected final int decodeUtf8_3(int c1)
                          throws javax.xml.stream.XMLStreamException

Note: caller must guarantee enough data is available before calling the method

Throws:

javax.xml.stream.XMLStreamException

decodeUtf8_3

protected final int decodeUtf8_3(int c1,
                                 int c2,
                                 int c3)
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

decodeUtf8_4

protected final int decodeUtf8_4(int c)
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

decodeUtf8_4

protected final int decodeUtf8_4(int c1,
                                 int c2,
                                 int c3,
                                 int c4)
                          throws javax.xml.stream.XMLStreamException

Returns:

Character value minus 0x10000; this so that caller can readily expand it to actual surrogates

Throws:

javax.xml.stream.XMLStreamException

addPName

protected final PName addPName(int hash,
                               int[] quads,
                               int qlen,
                               int lastQuadBytes)
                        throws javax.xml.stream.XMLStreamException

Specified by:

addPName in class AsyncByteScanner

Throws:

javax.xml.stream.XMLStreamException

reportInvalidInitial

protected void reportInvalidInitial(int mask)
                             throws javax.xml.stream.XMLStreamException

Overrides:

reportInvalidInitial in class ByteBasedScanner

Throws:

javax.xml.stream.XMLStreamException

reportInvalidOther

protected void reportInvalidOther(int mask)
                           throws javax.xml.stream.XMLStreamException

Overrides:

reportInvalidOther in class ByteBasedScanner

Throws:

javax.xml.stream.XMLStreamException

reportInvalidOther

protected void reportInvalidOther(int mask,
                                  int ptr)
                           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException