Package com.fasterxml.aalto.in

Class InputBootstrapper

java.lang.Object

com.fasterxml.aalto.in.InputBootstrapper

All Implemented Interfaces:

XmlConsts

Direct Known Subclasses:

ByteSourceBootstrapper, CharSourceBootstrapper

public abstract class InputBootstrapper
extends Object
implements XmlConsts

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

Field Summary

Fields

Modifier and Type	Field	Description
(package private) 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.
static final String	ERR_XMLDECL_END_MARKER
static final String	ERR_XMLDECL_EXP_ATTRVAL
static final String	ERR_XMLDECL_EXP_EQ
static final String	ERR_XMLDECL_EXP_SPACE
static final String	ERR_XMLDECL_KW_ENCODING
static final String	ERR_XMLDECL_KW_STANDALONE
static final String	ERR_XMLDECL_KW_VERSION
(package private) int	mDeclaredXmlVersion	XML declaration from the input (1.0, 1.1 or 'unknown')
(package private) String	mFoundEncoding	Value of encoding pseudo-attribute from xml declaration, if one was found; null otherwise.
(package private) final char[]	mKeyword	Need a short buffer to read in values of pseudo-attributes (version, encoding, standalone).
(package private) String	mStandalone

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

CHAR_CR, CHAR_LF, CHAR_NULL, CHAR_SPACE, MAX_UNICODE_CHAR, 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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputBootstrapper(ReaderConfig cfg)

Method Summary

Modifier and Type	Method	Description
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	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	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)

Methods inherited from class java.lang.Object

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

Field Details

ERR_XMLDECL_KW_VERSION

public static final String ERR_XMLDECL_KW_VERSION

See Also:

• Constant Field Values

ERR_XMLDECL_KW_ENCODING

public static final String ERR_XMLDECL_KW_ENCODING

See Also:

• Constant Field Values

ERR_XMLDECL_KW_STANDALONE

public static final String ERR_XMLDECL_KW_STANDALONE

See Also:

• Constant Field Values

ERR_XMLDECL_END_MARKER

public static final String ERR_XMLDECL_END_MARKER

See Also:

• Constant Field Values

ERR_XMLDECL_EXP_SPACE

public static final String ERR_XMLDECL_EXP_SPACE

See Also:

• Constant Field Values

ERR_XMLDECL_EXP_EQ

public static final String ERR_XMLDECL_EXP_EQ

See Also:

• Constant Field Values

ERR_XMLDECL_EXP_ATTRVAL

public static final String ERR_XMLDECL_EXP_ATTRVAL

See Also:

• Constant Field Values

_inputProcessed

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

protected int _inputRow

Current row location of current point in input buffer, using zero-based counting.

_inputRowStart

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.

_config

final ReaderConfig _config

mDeclaredXmlVersion

int mDeclaredXmlVersion

XML declaration from the input (1.0, 1.1 or 'unknown')

mFoundEncoding

String mFoundEncoding

Value of encoding pseudo-attribute from xml declaration, if one was found; null otherwise.

mStandalone

String mStandalone

mKeyword

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)

Constructor Details

InputBootstrapper

protected InputBootstrapper(ReaderConfig cfg)

Method Details

bootstrap

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.

Throws:

XMLStreamException

readXmlDeclaration

protected void readXmlDeclaration()
                           throws IOException,
XMLStreamException

Method that will parse xml declaration, which at this point is known to exist.

Throws:

IOException

XMLStreamException

readXmlVersion

private final int readXmlVersion()
                          throws IOException,
XMLStreamException

Returns:

Xml version declaration read

Throws:

IOException

XMLStreamException

readXmlEncoding

private final String readXmlEncoding()
                              throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

readXmlStandalone

private final String readXmlStandalone()
                                throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

handleEq

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

Throws:

IOException

XMLStreamException

getWsOrChar

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.

Throws:

IOException

XMLStreamException

pushback

protected abstract void pushback()

getNext

protected abstract int getNext()
                        throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

getNextAfterWs

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

Throws:

IOException

XMLStreamException

checkKeyword

protected abstract int checkKeyword(String exp)
                             throws IOException,
XMLStreamException

Returns:

First character that does not match expected, if any; CHAR_NULL if match succeeded

Throws:

IOException

XMLStreamException

readQuotedValue

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

Throws:

IOException

XMLStreamException

getLocation

protected abstract Location getLocation()

reportXmlProblem

protected void reportXmlProblem(String msg)
                         throws XMLStreamException

Throws:

XMLStreamException

reportNull

protected void reportNull()
                   throws XMLStreamException

Throws:

XMLStreamException

reportEof

protected void reportEof()
                  throws XMLStreamException

Throws:

XMLStreamException

reportUnexpectedChar

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

Throws:

XMLStreamException

reportPseudoAttrProblem

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

Throws:

XMLStreamException