Class ReaderScanner

java.lang.Object

com.fasterxml.aalto.in.XmlScanner

com.fasterxml.aalto.in.ReaderScanner

All Implemented Interfaces:

XmlConsts, NamespaceContext, XMLStreamConstants

public final class ReaderScanner
extends XmlScanner

This is the concrete scanner implementation used when input comes as a Reader. In general using this scanner is quite a bit less optimal than that of InputStream based scanner. Nonetheless, it is included for completeness, since Stax interface allows passing Readers as input sources.

Field Summary

Fields

Modifier and Type	Field	Description
protected Reader	_in	Underlying InputStream to use for reading content.
protected char[]	_inputBuffer
protected int	_inputEnd
protected int	_inputPtr
protected final CharBasedPNameTable	_symbols	For now, symbol table contains prefixed names.
protected int	mTmpChar	Storage location for a single character that can not be pushed back (for example, multi-byte char)
private static final XmlCharTypes	sCharTypes	Although java chars are basically UTF-16 in memory, the closest match for char types is Latin1.

Fields inherited from class 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 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 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
ReaderScanner(ReaderConfig cfg, Reader r)
ReaderScanner(ReaderConfig cfg, Reader r, char[] buffer, int ptr, int last)

Method Summary

Modifier and Type	Method	Description
protected void	_closeSource()
protected int	_nextEntity()	Helper method used to isolate things that need to be (re)set in cases where
protected void	_releaseBuffers()
protected final PName	addPName(char[] nameBuffer, int nameLen, int hash)
protected final int	checkInTreeIndentation(char c)	Note: consequtive white space is only considered indentation, if the following token seems like a tag (start/end).
protected final int	checkPrologIndentation(char c)
private char	checkSurrogate(char firstChar)	This method is called to verify that a surrogate pair found describes a legal surrogate pair (ie.
private int	checkSurrogateNameChar(char firstChar, char sec, int index)
private int	collectValue(int attrPtr, char quoteChar, PName attrName)	This method implements the tight loop for parsing attribute values.
private int	decodeSurrogate(char firstChar)	This method is similar to checkSurrogate, but returns the actual character code encoded by the surrogate pair.
protected final void	finishCData()
protected final void	finishCharacters()
protected final void	finishCoalescedCData()
protected final void	finishCoalescedCharacters()
protected final 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 final void	finishComment()
protected final void	finishDTD(boolean copyContents)
protected final void	finishPI()
protected final void	finishSpace()
protected final 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)
int	getCurrentColumnNr()
org.codehaus.stax2.XMLStreamLocation2	getCurrentLocation()
long	getEndingByteOffset()
long	getEndingCharOffset()
long	getStartingByteOffset()
long	getStartingCharOffset()
protected final int	handleCharEntity()
protected final int	handleCommentOrCdataStart()
private final int	handleDtdStart()
protected final int	handleEndElement()
protected final int	handleEntityInText(boolean inAttr)
private void	handleNsDeclaration(PName name, char quoteChar)	Method called from the main START_ELEMENT handling loop, to parse namespace URI values.
protected final int	handlePIStart()
protected final int	handlePrologDeclStart(boolean isProlog)
protected final int	handleStartElement(char c)
protected final boolean	loadAndRetain(int nrOfChars)
protected final boolean	loadMore()
protected final char	loadOne()
protected final char	loadOne(int type)
protected final void	markLF()
protected final void	markLF(int offset)
private final void	matchAsciiKeyword(String keyw)
final int	nextFromProlog(boolean isProlog)
final int	nextFromTree()
protected PName	parsePName(char c)
protected String	parsePublicId(char quoteChar)
protected String	parseSystemId(char quoteChar)
private void	reportInvalidFirstSurrogate(char ch)
private void	reportInvalidSecondSurrogate(char ch)
protected final void	setStartLocation()
protected final void	skipCData()
protected final boolean	skipCharacters()
protected final boolean	skipCoalescedText()	Method that gets called after a primary text segment (of type CHARACTERS or CDATA, not applicable to SPACE) has been skipped.
protected final void	skipComment()
protected char	skipInternalWs(boolean reqd, String msg)
protected final void	skipPI()
protected final void	skipSpace()

Methods inherited from class 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 Object

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

Field Details

sCharTypes

private static final XmlCharTypes sCharTypes

Although java chars are basically UTF-16 in memory, the closest match for char types is Latin1.

_in

protected Reader _in

Underlying InputStream to use for reading content.

_inputBuffer

protected char[] _inputBuffer

_inputPtr

protected int _inputPtr

_inputEnd

protected int _inputEnd

mTmpChar

protected int mTmpChar

Storage location for a single character that can not be pushed back (for example, multi-byte char)

_symbols

protected final CharBasedPNameTable _symbols

For now, symbol table contains prefixed names. In future it is possible that they may be split into prefixes and local names?

Constructor Details

ReaderScanner

public ReaderScanner(ReaderConfig cfg,
 Reader r,
 char[] buffer,
 int ptr,
 int last)

ReaderScanner

public ReaderScanner(ReaderConfig cfg,
 Reader r)

Method Details

_releaseBuffers

protected void _releaseBuffers()

Overrides:

_releaseBuffers in class XmlScanner

_closeSource

protected void _closeSource()
                     throws IOException

Specified by:

_closeSource in class XmlScanner

Throws:

IOException

finishToken

protected final void finishToken()
                          throws 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:

XMLStreamException

nextFromProlog

public final int nextFromProlog(boolean isProlog)
                         throws XMLStreamException

Specified by:

nextFromProlog in class XmlScanner

Throws:

XMLStreamException

nextFromTree

public final int nextFromTree()
                       throws XMLStreamException

Specified by:

nextFromTree in class XmlScanner

Throws:

XMLStreamException

_nextEntity

protected int _nextEntity()

Helper method used to isolate things that need to be (re)set in cases where

handlePrologDeclStart

protected final int handlePrologDeclStart(boolean isProlog)
                                   throws XMLStreamException

Throws:

XMLStreamException

handleDtdStart

private final int handleDtdStart()
                          throws XMLStreamException

Throws:

XMLStreamException

handleCommentOrCdataStart

protected final int handleCommentOrCdataStart()
                                       throws XMLStreamException

Throws:

XMLStreamException

handlePIStart

protected final int handlePIStart()
                           throws XMLStreamException

Throws:

XMLStreamException

handleCharEntity

protected final int handleCharEntity()
                              throws XMLStreamException

Returns:

Code point for the entity that expands to a valid XML content character.

Throws:

XMLStreamException

handleStartElement

protected final int handleStartElement(char c)
                                throws XMLStreamException

Throws:

XMLStreamException

collectValue

private int collectValue(int attrPtr,
 char quoteChar,
 PName attrName)
                  throws 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:

XMLStreamException

handleNsDeclaration

private void handleNsDeclaration(PName name,
 char quoteChar)
                          throws XMLStreamException

Method called from the main START_ELEMENT handling loop, to parse namespace URI values.

Throws:

XMLStreamException

handleEndElement

protected final int handleEndElement()
                              throws XMLStreamException

Throws:

XMLStreamException

handleEntityInText

protected final int handleEntityInText(boolean inAttr)
                                throws XMLStreamException

Throws:

XMLStreamException

finishComment

protected final void finishComment()
                            throws XMLStreamException

Specified by:

finishComment in class XmlScanner

Throws:

XMLStreamException

finishPI

protected final void finishPI()
                       throws XMLStreamException

Specified by:

finishPI in class XmlScanner

Throws:

XMLStreamException

finishDTD

protected final void finishDTD(boolean copyContents)
                        throws XMLStreamException

Specified by:

finishDTD in class XmlScanner

Throws:

XMLStreamException

finishCData

protected final void finishCData()
                          throws XMLStreamException

Specified by:

finishCData in class XmlScanner

Throws:

XMLStreamException

finishCharacters

protected final void finishCharacters()
                               throws XMLStreamException

Specified by:

finishCharacters in class XmlScanner

Throws:

XMLStreamException

finishSpace

protected final void finishSpace()
                          throws XMLStreamException

Specified by:

finishSpace in class XmlScanner

Throws:

XMLStreamException

finishCoalescedText

protected final void finishCoalescedText()
                                  throws 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:

XMLStreamException

finishCoalescedCData

protected final void finishCoalescedCData()
                                   throws XMLStreamException

Throws:

XMLStreamException

finishCoalescedCharacters

protected final void finishCoalescedCharacters()
                                        throws XMLStreamException

Throws:

XMLStreamException

skipCoalescedText

protected final boolean skipCoalescedText()
                                   throws 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:

XMLStreamException

skipComment

protected final void skipComment()
                          throws XMLStreamException

Specified by:

skipComment in class XmlScanner

Throws:

XMLStreamException

skipPI

protected final void skipPI()
                     throws XMLStreamException

Specified by:

skipPI in class XmlScanner

Throws:

XMLStreamException

skipCharacters

protected final boolean skipCharacters()
                                throws XMLStreamException

Specified by:

skipCharacters in class XmlScanner

Returns:

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

Throws:

XMLStreamException

skipCData

protected final void skipCData()
                        throws XMLStreamException

Specified by:

skipCData in class XmlScanner

Throws:

XMLStreamException

skipSpace

protected final void skipSpace()
                        throws XMLStreamException

Specified by:

skipSpace in class XmlScanner

Throws:

XMLStreamException

skipInternalWs

protected char skipInternalWs(boolean reqd,
 String msg)
                       throws XMLStreamException

Returns:

First byte following skipped white space

Throws:

XMLStreamException

matchAsciiKeyword

private final void matchAsciiKeyword(String keyw)
                              throws XMLStreamException

Throws:

XMLStreamException

checkInTreeIndentation

protected final int checkInTreeIndentation(char c)
                                    throws XMLStreamException

Note: consequtive white space is only considered indentation, if the following token seems like a tag (start/end). This so that if a CDATA section follows, it can be coalesced in coalescing mode. Although we could check if coalescing mode is enabled, this should seldom have significant effect either way, so it removes one possible source of problems in coalescing mode.

Returns:

-1, if indentation was handled; offset in the output buffer, if not

Throws:

XMLStreamException

checkPrologIndentation

protected final int checkPrologIndentation(char c)
                                    throws XMLStreamException

Returns:

-1, if indentation was handled; offset in the output buffer, if not

Throws:

XMLStreamException

parsePName

protected PName parsePName(char c)
                    throws XMLStreamException

Throws:

XMLStreamException

addPName

protected final PName addPName(char[] nameBuffer,
 int nameLen,
 int hash)
                        throws XMLStreamException

Throws:

XMLStreamException

parsePublicId

protected String parsePublicId(char quoteChar)
                        throws XMLStreamException

Throws:

XMLStreamException

parseSystemId

protected String parseSystemId(char quoteChar)
                        throws XMLStreamException

Throws:

XMLStreamException

checkSurrogate

private char checkSurrogate(char firstChar)
                     throws XMLStreamException

This method is called to verify that a surrogate pair found describes a legal surrogate pair (ie. expands to a legal XML char)

Throws:

XMLStreamException

checkSurrogateNameChar

private int checkSurrogateNameChar(char firstChar,
 char sec,
 int index)
                            throws XMLStreamException

Throws:

XMLStreamException

decodeSurrogate

private int decodeSurrogate(char firstChar)
                     throws XMLStreamException

This method is similar to checkSurrogate, but returns the actual character code encoded by the surrogate pair. This is needed if further validation rules (such as name charactert checks) are to be done.

Throws:

XMLStreamException

reportInvalidFirstSurrogate

private void reportInvalidFirstSurrogate(char ch)
                                  throws XMLStreamException

Throws:

XMLStreamException

reportInvalidSecondSurrogate

private void reportInvalidSecondSurrogate(char ch)
                                   throws XMLStreamException

Throws:

XMLStreamException

getCurrentLocation

public org.codehaus.stax2.XMLStreamLocation2 getCurrentLocation()

Specified by:

getCurrentLocation in class XmlScanner

Returns:

Current input location

getCurrentColumnNr

public int getCurrentColumnNr()

Specified by:

getCurrentColumnNr in class XmlScanner

getStartingByteOffset

public long getStartingByteOffset()

Specified by:

getStartingByteOffset in class XmlScanner

getStartingCharOffset

public long getStartingCharOffset()

Specified by:

getStartingCharOffset in class XmlScanner

getEndingByteOffset

public long getEndingByteOffset()
                         throws XMLStreamException

Specified by:

getEndingByteOffset in class XmlScanner

Throws:

XMLStreamException

getEndingCharOffset

public long getEndingCharOffset()
                         throws XMLStreamException

Specified by:

getEndingCharOffset in class XmlScanner

Throws:

XMLStreamException

markLF

protected final void markLF(int offset)

markLF

protected final void markLF()

setStartLocation

protected final void setStartLocation()

loadMore

protected final boolean loadMore()
                          throws XMLStreamException

Specified by:

loadMore in class XmlScanner

Throws:

XMLStreamException

loadOne

protected final char loadOne()
                      throws XMLStreamException

Throws:

XMLStreamException

loadOne

protected final char loadOne(int type)
                      throws XMLStreamException

Throws:

XMLStreamException

loadAndRetain

protected final boolean loadAndRetain(int nrOfChars)
                               throws XMLStreamException

Throws:

XMLStreamException