aalto-xml 1.3.2 · com.fasterxml.aalto.in.ReaderScanner

Modifier and Type	Field and 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.

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

Method Summary

Modifier and Type	Method and Description
protected void	_closeSource() Implements abstract com.fasterxml.aalto.in.XmlScanner._closeSource.
protected int	_nextEntity() Helper method used to isolate things that need to be (re)set in cases where
protected void	_releaseBuffers() Overrides com.fasterxml.aalto.in.XmlScanner._releaseBuffers.
protected final PName	addPName(char[] nameBuffer, int nameLen, int hash)
protected final int	Returns: -1, if indentation was handled; offset in the output buffer, if not checkInTreeIndentation(char c) Note consequtive white space is only considered indentation, if the following token seems like a tag (start/end).
protected final int	Returns: -1, if indentation was handled; offset in the output buffer, if not 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() Implements abstract com.fasterxml.aalto.in.XmlScanner.finishCData.
protected final void	finishCharacters() Implements abstract com.fasterxml.aalto.in.XmlScanner.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() Implements abstract com.fasterxml.aalto.in.XmlScanner.finishComment.
protected final void	finishDTD(boolean copyContents) Implements abstract com.fasterxml.aalto.in.XmlScanner.finishDTD.
protected final void	finishPI() Implements abstract com.fasterxml.aalto.in.XmlScanner.finishPI.
protected final void	finishSpace() Implements abstract com.fasterxml.aalto.in.XmlScanner.finishSpace.
protected final void	finishToken() Implements abstract com.fasterxml.aalto.in.XmlScanner.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)
public int	getCurrentColumnNr() Implements abstract com.fasterxml.aalto.in.XmlScanner.getCurrentColumnNr.
public XMLStreamLocation2	getCurrentLocation() Implements abstract com.fasterxml.aalto.in.XmlScanner.getCurrentLocation.
public long	getEndingByteOffset() Implements abstract com.fasterxml.aalto.in.XmlScanner.getEndingByteOffset.
public long	getEndingCharOffset() Implements abstract com.fasterxml.aalto.in.XmlScanner.getEndingCharOffset.
public long	getStartingByteOffset() Implements abstract com.fasterxml.aalto.in.XmlScanner.getStartingByteOffset.
public long	getStartingCharOffset() Implements abstract com.fasterxml.aalto.in.XmlScanner.getStartingCharOffset.
protected final int	Returns: Code point for the entity that expands to a valid XML content character. 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() Implements abstract com.fasterxml.aalto.in.XmlScanner.loadMore.
protected final char	loadOne()
protected final char	loadOne(int type)
protected final void	markLF(int offset)
protected final void	markLF()
private final void	matchAsciiKeyword(String keyw)
public final int	nextFromProlog(boolean isProlog) Implements abstract com.fasterxml.aalto.in.XmlScanner.nextFromProlog.
public final int	nextFromTree() Implements abstract com.fasterxml.aalto.in.XmlScanner.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() Implements abstract com.fasterxml.aalto.in.XmlScanner.skipCData.
protected final boolean	skipCharacters() Implements abstract com.fasterxml.aalto.in.XmlScanner.skipCharacters.
protected final boolean	Returns: True if we encountered an unexpandable entity skipCoalescedText() Implements abstract com.fasterxml.aalto.in.XmlScanner.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() Implements abstract com.fasterxml.aalto.in.XmlScanner.skipComment.
protected char	Returns: First byte following skipped white space skipInternalWs(boolean reqd, String msg)
protected final void	skipPI() Implements abstract com.fasterxml.aalto.in.XmlScanner.skipPI.
protected final void	skipSpace() Implements abstract com.fasterxml.aalto.in.XmlScanner.skipSpace.

Inherited from 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

_in	back to summary
protected Reader _in Underlying InputStream to use for reading content.

_inputBuffer	back to summary
protected char[] _inputBuffer

_inputEnd	back to summary
protected int _inputEnd

_inputPtr	back to summary
protected int _inputPtr

_symbols	back to summary
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?

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

sCharTypes	back to summary
private static final XmlCharTypes sCharTypes Although java chars are basically UTF-16 in memory, the closest match for char types is Latin1.

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

ReaderScanner	back to summary
public ReaderScanner(ReaderConfig cfg, Reader r)

Method Detail

_closeSource	back to summary
protected void _closeSource() throws IOException Implements abstract com.fasterxml.aalto.in.XmlScanner._closeSource. Annotations @Override

_closeSource

back to summary

protected void _closeSource() throws IOException

Implements abstract com.fasterxml.aalto.in.XmlScanner._closeSource.

Annotations

@Override

_nextEntity	back to summary
protected int _nextEntity() Helper method used to isolate things that need to be (re)set in cases where

_releaseBuffers	back to summary
protected void _releaseBuffers() Overrides com.fasterxml.aalto.in.XmlScanner._releaseBuffers. Annotations @Override

_releaseBuffers

back to summary

protected void _releaseBuffers()

Overrides com.fasterxml.aalto.in.XmlScanner._releaseBuffers.

Annotations

@Override

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

checkInTreeIndentation	back to summary
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:int -1, if indentation was handled; offset in the output buffer, if not

checkInTreeIndentation

back to summary

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:int: -1, if indentation was handled; offset in the output buffer, if not

checkPrologIndentation	back to summary
protected final int checkPrologIndentation(char c) throws XMLStreamException Returns:int -1, if indentation was handled; offset in the output buffer, if not

checkSurrogate	back to summary
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)

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

collectValue	back to summary
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.

decodeSurrogate	back to summary
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.

finishCData	back to summary
protected final void finishCData() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishCData. Annotations @Override

finishCData

back to summary

protected final void finishCData() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishCData.

Annotations

@Override

finishCharacters	back to summary
protected final void finishCharacters() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishCharacters. Annotations @Override

finishCharacters

back to summary

protected final void finishCharacters() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishCharacters.

Annotations

@Override

finishCoalescedCData	back to summary
protected final void finishCoalescedCData() throws XMLStreamException

finishCoalescedCharacters	back to summary
protected final void finishCoalescedCharacters() throws XMLStreamException

finishCoalescedText	back to summary
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).

finishComment	back to summary
protected final void finishComment() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishComment. Annotations @Override

finishComment

back to summary

protected final void finishComment() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishComment.

Annotations

@Override

finishDTD	back to summary
protected final void finishDTD(boolean copyContents) throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishDTD. Annotations @Override

finishDTD

back to summary

protected final void finishDTD(boolean copyContents) throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishDTD.

Annotations

@Override

finishPI	back to summary
protected final void finishPI() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishPI. Annotations @Override

finishPI

back to summary

protected final void finishPI() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishPI.

Annotations

@Override

finishSpace	back to summary
protected final void finishSpace() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishSpace. Annotations @Override

finishSpace

back to summary

protected final void finishSpace() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishSpace.

Annotations

@Override

finishToken	back to summary
protected final void finishToken() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.finishToken. Doc from com.fasterxml.aalto.in.XmlScanner.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) Annotations @Override

finishToken

back to summary

protected final void finishToken() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.finishToken.

Doc from com.fasterxml.aalto.in.XmlScanner.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)

Annotations

@Override

getCurrentColumnNr	back to summary
public int getCurrentColumnNr() Implements abstract com.fasterxml.aalto.in.XmlScanner.getCurrentColumnNr. Annotations @Override

getCurrentColumnNr

back to summary

public int getCurrentColumnNr()

Implements abstract com.fasterxml.aalto.in.XmlScanner.getCurrentColumnNr.

Annotations

@Override

getCurrentLocation	back to summary
public XMLStreamLocation2 getCurrentLocation() Implements abstract com.fasterxml.aalto.in.XmlScanner.getCurrentLocation. Returns:XMLStreamLocation2 Doc from com.fasterxml.aalto.in.XmlScanner.getCurrentLocation. Current input location Annotations @Override

getCurrentLocation

back to summary

public XMLStreamLocation2 getCurrentLocation()

Implements abstract com.fasterxml.aalto.in.XmlScanner.getCurrentLocation.

Returns:XMLStreamLocation2

Doc from com.fasterxml.aalto.in.XmlScanner.getCurrentLocation.

Current input location

Annotations

@Override

getEndingByteOffset	back to summary
public long getEndingByteOffset() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.getEndingByteOffset. Annotations @Override

getEndingByteOffset

back to summary

public long getEndingByteOffset() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.getEndingByteOffset.

Annotations

@Override

getEndingCharOffset	back to summary
public long getEndingCharOffset() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.getEndingCharOffset. Annotations @Override

getEndingCharOffset

back to summary

public long getEndingCharOffset() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.getEndingCharOffset.

Annotations

@Override

getStartingByteOffset	back to summary
public long getStartingByteOffset() Implements abstract com.fasterxml.aalto.in.XmlScanner.getStartingByteOffset. Annotations @Override

getStartingByteOffset

back to summary

public long getStartingByteOffset()

Implements abstract com.fasterxml.aalto.in.XmlScanner.getStartingByteOffset.

Annotations

@Override

getStartingCharOffset	back to summary
public long getStartingCharOffset() Implements abstract com.fasterxml.aalto.in.XmlScanner.getStartingCharOffset. Annotations @Override

getStartingCharOffset

back to summary

public long getStartingCharOffset()

Implements abstract com.fasterxml.aalto.in.XmlScanner.getStartingCharOffset.

Annotations

@Override

handleCharEntity	back to summary
protected final int handleCharEntity() throws XMLStreamException Returns:int Code point for the entity that expands to a valid XML content character.

handleCommentOrCdataStart	back to summary
protected final int handleCommentOrCdataStart() throws XMLStreamException

handleDtdStart	back to summary
private final int handleDtdStart() throws XMLStreamException

handleEndElement	back to summary
protected final int handleEndElement() throws XMLStreamException

handleEntityInText	back to summary
protected final int handleEntityInText(boolean inAttr) throws XMLStreamException

handleNsDeclaration	back to summary
private void handleNsDeclaration(PName name, char quoteChar) throws XMLStreamException Method called from the main START_ELEMENT handling loop, to parse namespace URI values.

handlePIStart	back to summary
protected final int handlePIStart() throws XMLStreamException

handlePrologDeclStart	back to summary
protected final int handlePrologDeclStart(boolean isProlog) throws XMLStreamException

handleStartElement	back to summary
protected final int handleStartElement(char c) throws XMLStreamException

loadAndRetain	back to summary
protected final boolean loadAndRetain(int nrOfChars) throws XMLStreamException

loadMore	back to summary
protected final boolean loadMore() throws XMLStreamException Implements abstract com.fasterxml.aalto.in.XmlScanner.loadMore. Annotations @Override

loadMore

back to summary

protected final boolean loadMore() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.loadMore.

Annotations

@Override

loadOne	back to summary
protected final char loadOne() throws XMLStreamException

loadOne	back to summary
protected final char loadOne(int type) throws XMLStreamException

markLF	back to summary
protected final void markLF(int offset)

markLF	back to summary
protected final void markLF()

matchAsciiKeyword	back to summary
private final void matchAsciiKeyword(String keyw) throws XMLStreamException

nextFromProlog

back to summary

public final int nextFromProlog(boolean isProlog) throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.nextFromProlog.

Annotations

@Override

nextFromTree

back to summary

public final int nextFromTree() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.nextFromTree.

Annotations

@Override

parsePName	back to summary
protected PName parsePName(char c) throws XMLStreamException

parsePublicId	back to summary
protected String parsePublicId(char quoteChar) throws XMLStreamException

parseSystemId	back to summary
protected String parseSystemId(char quoteChar) throws XMLStreamException

reportInvalidFirstSurrogate	back to summary
private void reportInvalidFirstSurrogate(char ch) throws XMLStreamException

reportInvalidSecondSurrogate	back to summary
private void reportInvalidSecondSurrogate(char ch) throws XMLStreamException

setStartLocation	back to summary
protected final void setStartLocation()

skipCData

back to summary

protected final void skipCData() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.skipCData.

Annotations

@Override

skipCharacters

back to summary

protected final boolean skipCharacters() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.skipCharacters.

Returns:boolean

Doc from com.fasterxml.aalto.in.XmlScanner.skipCharacters.

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

Annotations

@Override

skipCoalescedText

back to summary

protected final boolean skipCoalescedText() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.skipCoalescedText.

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).

Returns:boolean

True if we encountered an unexpandable entity

Annotations

@Override

skipComment

back to summary

protected final void skipComment() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.skipComment.

Annotations

@Override

skipInternalWs	back to summary
protected char skipInternalWs(boolean reqd, String msg) throws XMLStreamException Returns:char First byte following skipped white space

skipPI

back to summary

protected final void skipPI() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.skipPI.

Annotations

@Override

skipSpace

back to summary

protected final void skipSpace() throws XMLStreamException

Implements abstract com.fasterxml.aalto.in.XmlScanner.skipSpace.

Annotations

@Override

public final Class ReaderScanner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail