Top Description Fields Constructors Methods

com.fasterxml.aalto.in

public abstract Class InputBootstrapper

Class Inheritance

extends Object
implements XmlConsts

java.lang.Object
com.fasterxml.aalto.in.InputBootstrapper

All Implemented Interfaces

com.fasterxml.aalto.util.XmlConsts

Known Direct Subclasses

com.fasterxml.aalto.in.ByteSourceBootstrapper, com.fasterxml.aalto.in.CharSourceBootstrapper

Imports

java.io.*, javax.xml.stream.Location, .XMLStreamException, com.fasterxml.aalto.WFCException, com.fasterxml.aalto.util.XmlConsts

Abstract base class that defines shared functionality between different bootstrappers (byte stream, char Readers, block input)

Field Summary

Modifier and Type	Field and Description
pack-priv final ReaderConfig	_config
protected int	_inputProcessed Current number of input units (bytes or chars) that were processed in previous blocks, before contents of current input buffer.
protected int	_inputRow Current row location of current point in input buffer, using zero-based counting.
protected int	_inputRowStart Current index of the first character of the current row in input buffer.
public static final String	ERR_XMLDECL_END_MARKER
public static final String	ERR_XMLDECL_EXP_ATTRVAL
public static final String	ERR_XMLDECL_EXP_EQ
public static final String	ERR_XMLDECL_EXP_SPACE
public static final String	ERR_XMLDECL_KW_ENCODING
public static final String	ERR_XMLDECL_KW_STANDALONE
public static final String	ERR_XMLDECL_KW_VERSION
pack-priv int	mDeclaredXmlVersion XML declaration from the input (1.0, 1.1 or 'unknown')
pack-priv String	mFoundEncoding Value of encoding pseudo-attribute from xml declaration, if one was found; null otherwise.
pack-priv final char[]	mKeyword Need a short buffer to read in values of pseudo-attributes (version, encoding, standalone).
pack-priv String	mStandalone

Constructor Summary

Access	Constructor and Description
protected	InputBootstrapper(ReaderConfig cfg)

Method Summary

Modifier and Type	Method and Description
public abstract XmlScanner	bootstrap() Main bootstrapping method, which will try to open the underlying input source, check its encoding, read xml declaration if there is one, and finally create a scanner for actual parsing.
protected abstract int	Returns: First character that does not match expected, if any; CHAR_NULL if match succeeded checkKeyword(String exp)
protected abstract Location	getLocation()
protected abstract int	getNext()
protected abstract int	getNextAfterWs(boolean reqWs)
private final int	getWsOrChar(int ok) Method that should get next character, which has to be either specified character (usually end marker), OR, any character as long as there' at least one space character before it.
private final int	handleEq(String attr)
protected abstract void	pushback()
protected abstract int	readQuotedValue(char[] kw, int quoteChar)
protected void	readXmlDeclaration() Method that will parse xml declaration, which at this point is known to exist.
private final String	readXmlEncoding()
private final String	readXmlStandalone()
private final int	Returns: Xml version declaration read readXmlVersion()
protected void	reportEof()
protected void	reportNull()
protected final void	reportPseudoAttrProblem(String attrName, String got, String expVal1, String expVal2)
protected void	reportUnexpectedChar(int i, String msg)
protected void	reportXmlProblem(String msg)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_config	back to summary
pack-priv final ReaderConfig _config

_inputProcessed	back to summary
protected int _inputProcessed Current number of input units (bytes or chars) that were processed in previous blocks, before contents of current input buffer. Note includes possible BOMs, if those were part of the input.

_inputRow	back to summary
protected int _inputRow Current row location of current point in input buffer, using zero-based counting.

_inputRowStart	back to summary
protected int _inputRowStart Current index of the first character of the current row in input buffer. Needed to calculate column position, if necessary; benefit of not having column itself is that this only has to be updated once per line.

ERR_XMLDECL_END_MARKER	back to summary
public static final String ERR_XMLDECL_END_MARKER

ERR_XMLDECL_EXP_ATTRVAL	back to summary
public static final String ERR_XMLDECL_EXP_ATTRVAL

ERR_XMLDECL_EXP_EQ	back to summary
public static final String ERR_XMLDECL_EXP_EQ

ERR_XMLDECL_EXP_SPACE	back to summary
public static final String ERR_XMLDECL_EXP_SPACE

ERR_XMLDECL_KW_ENCODING	back to summary
public static final String ERR_XMLDECL_KW_ENCODING

ERR_XMLDECL_KW_STANDALONE	back to summary
public static final String ERR_XMLDECL_KW_STANDALONE

ERR_XMLDECL_KW_VERSION	back to summary
public static final String ERR_XMLDECL_KW_VERSION

mDeclaredXmlVersion	back to summary
pack-priv int mDeclaredXmlVersion XML declaration from the input (1.0, 1.1 or 'unknown')

mFoundEncoding	back to summary
pack-priv String mFoundEncoding Value of encoding pseudo-attribute from xml declaration, if one was found; null otherwise.

mKeyword	back to summary
pack-priv final char[] mKeyword Need a short buffer to read in values of pseudo-attributes (version, encoding, standalone). Don't really need tons of space; just enough for the longest anticipated encoding id... and maybe few chars just in case (for additional white space that we ignore)

mStandalone	back to summary
pack-priv String mStandalone

Constructor Detail

InputBootstrapper	back to summary
protected InputBootstrapper(ReaderConfig cfg)

Method Detail

bootstrap	back to summary
public abstract XmlScanner bootstrap() throws XMLStreamException Main bootstrapping method, which will try to open the underlying input source, check its encoding, read xml declaration if there is one, and finally create a scanner for actual parsing.

checkKeyword	back to summary
protected abstract int checkKeyword(String exp) throws IOException, XMLStreamException Returns:int First character that does not match expected, if any; CHAR_NULL if match succeeded

getLocation	back to summary
protected abstract Location getLocation()

getNext	back to summary
protected abstract int getNext() throws IOException, XMLStreamException

getNextAfterWs	back to summary
protected abstract int getNextAfterWs(boolean reqWs) throws IOException, XMLStreamException

getWsOrChar	back to summary
private final int getWsOrChar(int ok) throws IOException, XMLStreamException Method that should get next character, which has to be either specified character (usually end marker), OR, any character as long as there' at least one space character before it.

handleEq	back to summary
private final int handleEq(String attr) throws IOException, XMLStreamException

pushback	back to summary
protected abstract void pushback()

readQuotedValue	back to summary
protected abstract int readQuotedValue(char[] kw, int quoteChar) throws IOException, XMLStreamException

readXmlDeclaration	back to summary
protected void readXmlDeclaration() throws IOException, XMLStreamException Method that will parse xml declaration, which at this point is known to exist.

readXmlEncoding	back to summary
private final String readXmlEncoding() throws IOException, XMLStreamException

readXmlStandalone	back to summary
private final String readXmlStandalone() throws IOException, XMLStreamException

readXmlVersion	back to summary
private final int readXmlVersion() throws IOException, XMLStreamException Returns:int Xml version declaration read

reportEof	back to summary
protected void reportEof() throws XMLStreamException

reportNull	back to summary
protected void reportNull() throws XMLStreamException

reportPseudoAttrProblem	back to summary
protected final void reportPseudoAttrProblem(String attrName, String got, String expVal1, String expVal2) throws XMLStreamException

reportUnexpectedChar	back to summary
protected void reportUnexpectedChar(int i, String msg) throws XMLStreamException

reportXmlProblem	back to summary
protected void reportXmlProblem(String msg) throws XMLStreamException