java.lang.Object
- com.fasterxml.aalto.in.XmlScanner
- - com.fasterxml.aalto.in.ByteBasedScanner
  - - com.fasterxml.aalto.in.StreamScanner
    - - com.fasterxml.aalto.in.Utf8Scanner

All Implemented Interfaces:

XmlConsts, javax.xml.namespace.NamespaceContext, javax.xml.stream.XMLStreamConstants
```
public final class Utf8Scanner
extends StreamScanner
```
Scanner for tokenizing XML content from a byte stream encoding using UTF-8 encoding, or something suitably close it for decoding purposes (including ISO-Latin1 and US-ASCII).

Field Summary
- Fields inherited from class com.fasterxml.aalto.in.StreamScanner
  _charTypes, _in, _inputBuffer, _quadBuffer, _symbols
- Fields inherited from class com.fasterxml.aalto.in.ByteBasedScanner
  _inputEnd, _inputPtr, _tmpChar, 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
- 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, _nsBindingCache, _nsBindingCount, _nsBindings, _nsBindMisses, _pastBytesOrChars, _publicId, _rowStartOffset, _startColumn, _startRawOffset, _startRow, _systemId, _textBuilder, _tokenIncomplete, _tokenName, _xml11, CDATA_STR, INT_0, INT_9, INT_a, INT_A, INT_AMP, INT_APOS, INT_COLON, INT_CR, INT_EQ, INT_EXCL, INT_f, INT_F, INT_GT, INT_HYPHEN, INT_LBRACKET, INT_LF, INT_LT, INT_NULL, INT_QMARK, INT_QUOTE, INT_RBRACKET, INT_SLASH, INT_SPACE, INT_TAB, INT_z, MAX_UNICODE_CHAR, TOKEN_EOI
- Fields inherited from interface com.fasterxml.aalto.util.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

Constructors
Constructor Description

Utf8Scanner(ReaderConfig cfg, java.io.InputStream in, byte[] buffer, int ptr, int last)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private int`	`collectValue(int attrPtr, byte quoteByte, PName attrName)`	This method implements the tight loop for parsing attribute values.
`int`	`decodeCharForError(byte b)`	Method called called to decode a full UTF-8 characters, given its first byte.
`private int`	`decodeMultiByteChar(int c, int ptr)`
`private int`	`decodeUtf8_2(int c)`
`private int`	`decodeUtf8_3(int c1)`
`private int`	`decodeUtf8_3fast(int c1)`
`private int`	`decodeUtf8_4(int c)`
`protected void`	`finishCData()`
`protected void`	`finishCharacters()`
`protected void`	`finishCoalescedCData()`
`protected void`	`finishCoalescedCharacters()`
`protected void`	`finishCoalescedText()`	Method that gets called after a primary text segment (of type CHARACTERS or CDATA, not applicable to SPACE) has been read in text buffer.
`protected void`	`finishComment()`
`protected void`	`finishDTD(boolean copyContents)`	When this method gets called we know that we have an internal subset, and that the opening '[' has already been read.
`protected void`	`finishPI()`
`protected void`	`finishSpace()`	Note: this method is only called in cases where it is known that only space chars are legal.
`protected void`	`finishToken()`	This method is called to ensure that the current token/event has been completely parsed, such that we have all the data needed to return it (textual content, PI data, comment text etc)
`protected int`	`handleEntityInText(boolean inAttr)`	Method called when an ampersand is encounter in text segment.
`private void`	`handleNsDeclaration(PName name, byte quoteByte)`	Method called from the main START_ELEMENT handling loop, to parse namespace URI values.
`protected int`	`handleStartElement(byte b)`	Parsing of start element requires parsing of the element name (and attribute names), and is thus encoding-specific.
`protected java.lang.String`	`parsePublicId(byte quoteChar)`	Parsing of public ids is bit more complicated than that of system ids, since white space is to be coalesced.
`protected java.lang.String`	`parseSystemId(byte quoteChar)`
`protected void`	`reportInvalidOther(int mask, int ptr)`
`protected void`	`skipCData()`
`protected boolean`	`skipCharacters()`
`protected boolean`	`skipCoalescedText()`	Method that gets called after a primary text segment (of type CHARACTERS or CDATA, not applicable to SPACE) has been skipped.
`protected void`	`skipComment()`
`protected void`	`skipPI()`
`protected void`	`skipSpace()`
`private void`	`skipUtf8_2(int c)`
`private void`	`skipUtf8_3(int c)`
`private void`	`skipUtf8_4(int c)`
`private void`	`skipUtf8_4Slow(int c)`

Methods inherited from class com.fasterxml.aalto.in.StreamScanner
_closeSource, _nextEntity, _releaseBuffers, addPName, checkInTreeIndentation, checkPrologIndentation, handleCharEntity, handleEndElement, loadAndRetain, loadMore, loadOne, loadOne, nextByte, nextByte, nextFromProlog, nextFromTree, parsePName, parsePNameLong, parsePNameMedium, parsePNameSlow, skipInternalWs

Methods inherited from class com.fasterxml.aalto.in.ByteBasedScanner
addUTFPName, getCurrentColumnNr, getCurrentLocation, getEndingByteOffset, getEndingCharOffset, getStartingByteOffset, getStartingCharOffset, markLF, markLF, reportInvalidInitial, reportInvalidOther, setStartLocation

Methods inherited from class com.fasterxml.aalto.in.XmlScanner
bindName, bindNs, checkImmutableBinding, close, decodeAttrBinaryValue, decodeAttrValue, decodeAttrValues, decodeElements, findAttrIndex, findOrCreateBinding, fireSaxCharacterEvents, fireSaxCommentEvent, fireSaxEndElement, fireSaxPIEvent, fireSaxSpaceEvents, fireSaxStartElement, getAttrCollector, getAttrCount, getAttrLocalName, getAttrNsURI, getAttrPrefix, getAttrPrefixedName, getAttrQName, getAttrType, getAttrValue, getAttrValue, getConfig, getCurrentLineNr, getDepth, getDTDPublicId, getDTDSystemId, getEndLocation, getInputPublicId, getInputSystemId, getName, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getNonTransientNamespaceContext, getNsCount, getPrefix, getPrefixes, getQName, getStartLocation, getText, getText, getTextCharacters, getTextCharacters, getTextLength, handleInvalidXmlChar, hasEmptyStack, isAttrSpecified, isEmptyTag, isTextWhitespace, loadMoreGuaranteed, loadMoreGuaranteed, reportDoubleHyphenInComments, reportDuplicateNsDecl, reportEntityOverflow, reportEofInName, reportIllegalCDataEnd, reportIllegalNsDecl, reportIllegalNsDecl, reportInputProblem, reportInvalidNameChar, reportInvalidNsIndex, reportInvalidXmlChar, reportMissingPISpace, reportMultipleColonsInName, reportPrologProblem, reportPrologUnexpChar, reportPrologUnexpElement, reportTreeUnexpChar, reportUnboundPrefix, reportUnexpandedEntityInAttr, reportUnexpectedEndTag, resetForDecoding, skipToken, throwInvalidSpace, throwNullChar, throwUnexpectedChar, verifyXmlChar

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Utf8Scanner
```
public Utf8Scanner(ReaderConfig cfg,
                   java.io.InputStream in,
                   byte[] buffer,
                   int ptr,
                   int last)
```
- Method Detail
  - finishToken
```
protected final void finishToken()
                          throws javax.xml.stream.XMLStreamException
```
    Description copied from class: XmlScanner
    
    This method is called to ensure that the current token/event has been completely parsed, such that we have all the data needed to return it (textual content, PI data, comment text etc)
    
    Specified by:
    
    finishToken in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - handleStartElement
```
protected int handleStartElement(byte b)
                          throws javax.xml.stream.XMLStreamException
```
    Description copied from class: StreamScanner
    
    Parsing of start element requires parsing of the element name (and attribute names), and is thus encoding-specific.
    
    Specified by:
    
    handleStartElement in class StreamScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - collectValue
```
private final int collectValue(int attrPtr,
                               byte quoteByte,
                               PName attrName)
                        throws javax.xml.stream.XMLStreamException
```
    This method implements the tight loop for parsing attribute values. It's off-lined from the main start element method to simplify main method, which makes code more maintainable and possibly easier for JIT/HotSpot to optimize.
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - handleNsDeclaration
```
private void handleNsDeclaration(PName name,
                                 byte quoteByte)
                          throws javax.xml.stream.XMLStreamException
```
    Method called from the main START_ELEMENT handling loop, to parse namespace URI values.
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - handleEntityInText
```
protected final int handleEntityInText(boolean inAttr)
                                throws javax.xml.stream.XMLStreamException
```
    Method called when an ampersand is encounter in text segment. Method needs to determine whether it is a pre-defined or character entity (in which case it will be expanded into a single char or surrogate pair), or a general entity (in which case it will most likely be returned as ENTITY_REFERENCE event)
    
    Specified by:
    
    handleEntityInText in class StreamScanner
    
    Parameters:
    
    inAttr - True, if reference is from attribute value; false if from normal text content
    
    Returns:
    
    0 if a general parsed entity encountered; integer value of a (valid) XML content character otherwise
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - parsePublicId
```
protected java.lang.String parsePublicId(byte quoteChar)
                                  throws javax.xml.stream.XMLStreamException
```
    Parsing of public ids is bit more complicated than that of system ids, since white space is to be coalesced.
    
    Specified by:
    
    parsePublicId in class StreamScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - parseSystemId
```
protected java.lang.String parseSystemId(byte quoteChar)
                                  throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    parseSystemId in class StreamScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipCharacters
```
protected final boolean skipCharacters()
                                throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    skipCharacters in class XmlScanner
    
    Returns:
    
    True, if an unexpanded entity was encountered (and is now pending)
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipComment
```
protected final void skipComment()
                          throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    skipComment in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipCData
```
protected final void skipCData()
                        throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    skipCData in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipPI
```
protected final void skipPI()
                     throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    skipPI in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipSpace
```
protected final void skipSpace()
                        throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    skipSpace in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipUtf8_2
```
private final void skipUtf8_2(int c)
                       throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipUtf8_3
```
private final void skipUtf8_3(int c)
                       throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipUtf8_4
```
private final void skipUtf8_4(int c)
                       throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipUtf8_4Slow
```
private final void skipUtf8_4Slow(int c)
                           throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishCData
```
protected final void finishCData()
                          throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    finishCData in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishCharacters
```
protected final void finishCharacters()
                               throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    finishCharacters in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishComment
```
protected final void finishComment()
                            throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    finishComment in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishDTD
```
protected final void finishDTD(boolean copyContents)
                        throws javax.xml.stream.XMLStreamException
```
    When this method gets called we know that we have an internal subset, and that the opening '[' has already been read.
    
    Specified by:
    
    finishDTD in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishPI
```
protected final void finishPI()
                       throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    finishPI in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishSpace
```
protected final void finishSpace()
                          throws javax.xml.stream.XMLStreamException
```
    Note: this method is only called in cases where it is known that only space chars are legal. Thus, encountering a non-space is an error (WFC or VC). However, an end-of-input is ok.
    
    Specified by:
    
    finishSpace in class XmlScanner
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishCoalescedText
```
protected final void finishCoalescedText()
                                  throws javax.xml.stream.XMLStreamException
```
    Method that gets called after a primary text segment (of type CHARACTERS or CDATA, not applicable to SPACE) has been read in text buffer. Method has to see if the following event would be textual as well, and if so, read it (and any other following textual segments).
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishCoalescedCharacters
```
protected final void finishCoalescedCharacters()
                                        throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - finishCoalescedCData
```
protected final void finishCoalescedCData()
                                   throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipCoalescedText
```
protected final boolean skipCoalescedText()
                                   throws javax.xml.stream.XMLStreamException
```
    Method that gets called after a primary text segment (of type CHARACTERS or CDATA, not applicable to SPACE) has been skipped. Method has to see if the following event would be textual as well, and if so, skip it (and any other following textual segments).
    
    Specified by:
    
    skipCoalescedText in class XmlScanner
    
    Returns:
    
    True if we encountered an unexpandable entity
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - decodeMultiByteChar
```
private final int decodeMultiByteChar(int c,
                                      int ptr)
                               throws javax.xml.stream.XMLStreamException
```
    Returns:
    
    Either decoded character (if positive int); or negated value of a high-order char (one that needs surrogate pair)
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - decodeUtf8_2
```
private final int decodeUtf8_2(int c)
                        throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - decodeUtf8_3
```
private final int decodeUtf8_3(int c1)
                        throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - decodeUtf8_3fast
```
private final int decodeUtf8_3fast(int c1)
                            throws javax.xml.stream.XMLStreamException
```
    Throws:
    
    javax.xml.stream.XMLStreamException
  - decodeUtf8_4
```
private final int decodeUtf8_4(int c)
                        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
  decodeCharForError
  
  public int decodeCharForError(byte b) throws javax.xml.stream.XMLStreamException
  
  Method called called to decode a full UTF-8 characters, given its first byte. Note: does not do any validity checks, since this is only to be used for informational purposes (often when an error has already been encountered)
  
  Specified by:
  
  decodeCharForError 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

Class Utf8Scanner

Field Summary

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

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

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

Fields inherited from interface com.fasterxml.aalto.util.XmlConsts

Fields inherited from interface javax.xml.stream.XMLStreamConstants

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Utf8Scanner

Method Detail

finishToken

handleStartElement

collectValue

handleNsDeclaration

handleEntityInText

parsePublicId

parseSystemId

skipCharacters

skipComment

skipCData

skipPI

skipSpace

skipUtf8_2

skipUtf8_3

skipUtf8_4

skipUtf8_4Slow

finishCData

finishCharacters

finishComment

finishDTD

finishPI

finishSpace

finishCoalescedText

finishCoalescedCharacters

finishCoalescedCData

skipCoalescedText

decodeMultiByteChar

decodeUtf8_2

decodeUtf8_3

decodeUtf8_3fast

decodeUtf8_4

decodeCharForError

reportInvalidOther