Woodstox 6.5.1 · com.ctc.wstx.io.InputBootstrapper · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final byte	BYTE_CR
public static final byte	BYTE_LF
public static final byte	BYTE_NULL
public static final byte	CHAR_CR
public static final byte	CHAR_LF
public static final char	CHAR_NEL
public static final char	CHAR_NULL
public static final char	CHAR_SPACE
protected static final String	ERR_XMLDECL_END_MARKER
protected static final String	ERR_XMLDECL_EXP_ATTRVAL
protected static final String	ERR_XMLDECL_EXP_EQ
protected static final String	ERR_XMLDECL_EXP_SPACE
protected static final String	ERR_XMLDECL_KW_ENCODING
protected static final String	ERR_XMLDECL_KW_STANDALONE
protected static final String	ERR_XMLDECL_KW_VERSION
protected int	mDeclaredXmlVersion XML declaration from the input (1.0, 1.1 or 'unknown')
protected String	mFoundEncoding Value of encoding pseudo-attribute from xml declaration, if one was found; null otherwise.
protected int	mInputProcessed Current number of characters that were processed in previous blocks, before contents of current input buffer.
protected int	mInputRow Current row location of current point in input buffer, starting from 1
protected int	mInputRowStart Current index of the first character of the current row in input buffer.
protected final char[]	mKeywordBuffer Need a short buffer to read in values of pseudo-attributes (version, encoding, standalone).
protected final String	mPublicId
protected String	mStandalone
protected final SystemId	mSystemId
protected boolean	mXml11Handling Flag that indicates whether input read from this input source needs to be xml 1.1 compliant or not; if not, xml 1.0 is assumed.

Constructor Summary

Access	Constructor and Description
protected	InputBootstrapper(String pubId, SystemId sysId)

Method Summary

Modifier and Type	Method and Description
public abstract Reader	bootstrapInput(ReaderConfig cfg, boolean mainDoc, int Optional xml version identifier of the main parsed document (if not bootstrapping the main document). Currently only relevant for checking that XML 1.0 document does not include XML 1.1 external parsed entities. If null, no checks will be done; when bootstrapping parsing of the main document, null should be passed for this argument. xmlVersion)
protected abstract int	Returns: First character that does not match expected, if any; CHAR_NULL if match succeeded checkKeyword(String exp)
public boolean	Returns: True, if the input bootstrapped declared that it conforms to xml 1.1 (independent of where it was included from) declaredXml11()
public String	Returns: Encoding declaration found from the xml declaration, if any; null if none. getDeclaredEncoding()
public int	getDeclaredVersion()
public abstract int	getInputColumn()
public abstract String	Returns: Input encoding in use, if it could be determined or was passed by the calling application getInputEncoding() Actual character encoding used by the underlying input source; may have been passed by the application, or auto-detected by byte stream boot strapper (can not be determined from a Reader source).
public int	getInputRow()
public abstract int	Returns: Total number of characters read from bootstrapped input (stream, reader) getInputTotal()
protected abstract Location	getLocation()
protected abstract int	getNext()
protected abstract int	getNextAfterWs(boolean reqWs)
public String	getPublicId()
public String	getStandalone()
public SystemId	getSystemId()
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 void	initFrom(InputBootstrapper src)
protected abstract void	pushback()
protected abstract int	readQuotedValue(char[] kw, int quoteChar)
protected void	readXmlDecl(boolean isMainDoc, int Optional xml version identifier of the main parsed document (if not bootstrapping the main document). Currently only relevant for checking that XML 1.0 document does not include XML 1.1 external parsed entities. If null, no checks will be done; when bootstrapping parsing of the main document, null should be passed for this argument. xmlVersion)
private final String	readXmlEncoding()
private final String	readXmlStandalone()
private final int	Returns: Xml version declaration read readXmlVersion()
protected void	reportNull()
private 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

BYTE_CR	back to summary
public static final byte BYTE_CR

BYTE_LF	back to summary
public static final byte BYTE_LF

BYTE_NULL	back to summary
public static final byte BYTE_NULL

CHAR_CR	back to summary
public static final byte CHAR_CR

CHAR_LF	back to summary
public static final byte CHAR_LF

CHAR_NEL	back to summary
public static final char CHAR_NEL

CHAR_NULL	back to summary
public static final char CHAR_NULL

CHAR_SPACE	back to summary
public static final char CHAR_SPACE

ERR_XMLDECL_END_MARKER	back to summary
protected static final String ERR_XMLDECL_END_MARKER

ERR_XMLDECL_EXP_ATTRVAL	back to summary
protected static final String ERR_XMLDECL_EXP_ATTRVAL

ERR_XMLDECL_EXP_EQ	back to summary
protected static final String ERR_XMLDECL_EXP_EQ

ERR_XMLDECL_EXP_SPACE	back to summary
protected static final String ERR_XMLDECL_EXP_SPACE

ERR_XMLDECL_KW_ENCODING	back to summary
protected static final String ERR_XMLDECL_KW_ENCODING

ERR_XMLDECL_KW_STANDALONE	back to summary
protected static final String ERR_XMLDECL_KW_STANDALONE

ERR_XMLDECL_KW_VERSION	back to summary
protected static final String ERR_XMLDECL_KW_VERSION

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

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

mInputProcessed	back to summary
protected int mInputProcessed Current number of characters that were processed in previous blocks, before contents of current input buffer.

mInputRow	back to summary
protected int mInputRow Current row location of current point in input buffer, starting from 1

mInputRowStart	back to summary
protected int mInputRowStart 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.

mKeywordBuffer	back to summary
protected final char[] mKeywordBuffer 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)

mPublicId	back to summary
protected final String mPublicId

mStandalone	back to summary
protected String mStandalone

mSystemId	back to summary
protected final SystemId mSystemId

mXml11Handling	back to summary
protected boolean mXml11Handling Flag that indicates whether input read from this input source needs to be xml 1.1 compliant or not; if not, xml 1.0 is assumed. State of this flag depends on parent context (if one existed), or if not, on xml declaration of this input source.

Constructor Detail

InputBootstrapper	back to summary
protected InputBootstrapper(String pubId, SystemId sysId)

Method Detail

bootstrapInput	back to summary
public abstract Reader bootstrapInput(ReaderConfig cfg, boolean mainDoc, int xmlVersion) throws IOException, XMLStreamException Parameters xmlVersion:int Optional xml version identifier of the main parsed document (if not bootstrapping the main document). Currently only relevant for checking that XML 1.0 document does not include XML 1.1 external parsed entities. If null, no checks will be done; when bootstrapping parsing of the main document, null should be passed for this argument.

bootstrapInput

back to summary

public abstract Reader bootstrapInput(ReaderConfig cfg, boolean mainDoc, int xmlVersion) throws IOException, XMLStreamException

Parameters

xmlVersion:int: Optional xml version identifier of the main parsed document (if not bootstrapping the main document). Currently only relevant for checking that XML 1.0 document does not include XML 1.1 external parsed entities. If null, no checks will be done; when bootstrapping parsing of the main document, null should be passed for this argument.

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

declaredXml11	back to summary
public boolean declaredXml11() Returns:boolean True, if the input bootstrapped declared that it conforms to xml 1.1 (independent of where it was included from)

getDeclaredEncoding	back to summary
public String getDeclaredEncoding() Returns:String Encoding declaration found from the xml declaration, if any; null if none.

getDeclaredVersion	back to summary
public int getDeclaredVersion()

getInputColumn	back to summary
public abstract int getInputColumn()

getInputEncoding	back to summary
public abstract String getInputEncoding() Actual character encoding used by the underlying input source; may have been passed by the application, or auto-detected by byte stream boot strapper (can not be determined from a Reader source). Returns:String Input encoding in use, if it could be determined or was passed by the calling application

getInputEncoding

back to summary

public abstract String getInputEncoding()

Actual character encoding used by the underlying input source; may have been passed by the application, or auto-detected by byte stream boot strapper (can not be determined from a Reader source).

Returns:String: Input encoding in use, if it could be determined or was passed by the calling application

getInputRow	back to summary
public int getInputRow()

getInputTotal	back to summary
public abstract int getInputTotal() Returns:int Total number of characters read from bootstrapped input (stream, reader)

getLocation	back to summary
protected abstract Location getLocation()

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

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

getPublicId	back to summary
public String getPublicId()

getStandalone	back to summary
public String getStandalone()

getSystemId	back to summary
public SystemId getSystemId()

getWsOrChar	back to summary
private final int getWsOrChar(int ok) throws IOException, WstxException 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, WstxException

initFrom	back to summary
protected void initFrom(InputBootstrapper src)

pushback	back to summary
protected abstract void pushback()

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

readXmlDecl	back to summary
protected void readXmlDecl(boolean isMainDoc, int xmlVersion) throws IOException, WstxException Parameters xmlVersion:int Optional xml version identifier of the main parsed document (if not bootstrapping the main document). Currently only relevant for checking that XML 1.0 document does not include XML 1.1 external parsed entities. If null, no checks will be done; when bootstrapping parsing of the main document, null should be passed for this argument.

readXmlDecl

back to summary

protected void readXmlDecl(boolean isMainDoc, int xmlVersion) throws IOException, WstxException

Parameters

xmlVersion:int: Optional xml version identifier of the main parsed document (if not bootstrapping the main document). Currently only relevant for checking that XML 1.0 document does not include XML 1.1 external parsed entities. If null, no checks will be done; when bootstrapping parsing of the main document, null should be passed for this argument.

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

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

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

reportNull	back to summary
protected void reportNull() throws WstxException

reportPseudoAttrProblem	back to summary
private final void reportPseudoAttrProblem(String attrName, String got, String expVal1, String expVal2) throws WstxException

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

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

public abstract Class InputBootstrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail