java.lang.Object

com.ctc.wstx.io.InputBootstrapper

com.ctc.wstx.io.StreamBootstrapper

public final class StreamBootstrapper extends InputBootstrapper

Input bootstrap class used with streams, when encoding is not known (when encoding is specified by application, a reader is constructed, and then reader-based bootstrapper is used).

Encoding used for an entity (including main document entity) is determined using algorithms suggested in XML 1.0#3 spec, appendix F

Field Summary

Fields

Modifier and Type

Field

Description

(package private) boolean

mBigEndian

private byte[]

mByteBuffer

(package private) boolean

mByteSizeFound

(package private) int

mBytesPerChar

For most encodings, number of physical characters needed for decoding xml declaration characters (which for variable length encodings like UTF-8 will be 1).

(package private) boolean

mEBCDIC

Special case for 1-byte encodings: EBCDIC is problematic as it's not 7-bit ascii compatible.

(package private) boolean

mHadBOM

(package private) final InputStream

mIn

Underlying InputStream to use for reading content.

(package private) static final int

MIN_BUF_SIZE

Let's size buffer at least big enough to contain the longest possible prefix of a document needed to positively identify it starts with the XML declaration.

(package private) String

mInputEncoding

private int

mInputEnd

private int

mInputPtr

private final boolean

mRecycleBuffer

Whether byte buffer is recyclable or not

(package private) int[]

mSingleByteTranslation

For single-byte non-ascii-compatible encodings (ok ok, really just EBCDIC), we'll have to use a lookup table.

Fields inherited from class com.ctc.wstx.io.InputBootstrapper
BYTE_CR, BYTE_LF, BYTE_NULL, CHAR_CR, CHAR_LF, CHAR_NEL, CHAR_NULL, CHAR_SPACE, ERR_XMLDECL_END_MARKER, ERR_XMLDECL_EXP_ATTRVAL, ERR_XMLDECL_EXP_EQ, ERR_XMLDECL_EXP_SPACE, ERR_XMLDECL_KW_ENCODING, ERR_XMLDECL_KW_STANDALONE, ERR_XMLDECL_KW_VERSION, mDeclaredXmlVersion, mFoundEncoding, mInputProcessed, mInputRow, mInputRowStart, mKeywordBuffer, mPublicId, mStandalone, mSystemId, mXml11Handling
Constructor Summary

Constructors

Modifier

Constructor

Description

private

StreamBootstrapper(String pubId, SystemId sysId, byte[] data, int start, int end)

private

StreamBootstrapper(String pubId, SystemId sysId, InputStream in)
Method Summary

Modifier and Type

Method

Description

Reader

bootstrapInput(ReaderConfig cfg, boolean mainDoc, int xmlVersion)

protected int

checkKeyword(String exp)

protected int

checkMbKeyword(String expected)

protected int

checkSbKeyword(String expected)

protected int

checkTranslatedKeyword(String expected)

protected boolean

ensureLoaded(int minimum)

int

getInputColumn()

String

getInputEncoding()

Since this class only gets used when encoding is not explicitly passed, need use the encoding that was auto-detected...

int

getInputTotal()

static StreamBootstrapper

getInstance(String pubId, SystemId sysId, byte[] data, int start, int end)

Factory method used when the underlying data provider is a pre-allocated block source, and no stream is used.

static StreamBootstrapper

getInstance(String pubId, SystemId sysId, InputStream in)

Factory method used when the underlying data provider is an actual stream.

protected Location

getLocation()

protected int

getNext()

protected int

getNextAfterWs(boolean reqWs)

protected boolean

hasXmlDecl()

protected void

loadMore()

protected byte

nextByte()

protected int

nextMultiByte()

protected int

nextTranslated()

protected void

pushback()

protected int

readQuotedValue(char[] outputBuffer, int quoteChar)

private void

reportWeirdUCS4(String type)

protected void

resolveStreamEncoding()

Method called to try to figure out physical encoding the underlying input stream uses.

protected void

skipMbLF(int lf)

protected int

skipMbWs()

protected void

skipSbLF(byte lfByte)

protected int

skipSbWs()

protected void

skipTranslatedLF(int lf)

protected int

skipTranslatedWs()

private void

verifyEncoding(String id, int bpc)

private void

verifyEncoding(String id, int bpc, boolean bigEndian)

protected String

verifyXmlEncoding(String enc)

Methods inherited from class com.ctc.wstx.io.InputBootstrapper
declaredXml11, getDeclaredEncoding, getDeclaredVersion, getInputRow, getPublicId, getStandalone, getSystemId, initFrom, readXmlDecl, reportNull, reportUnexpectedChar, reportXmlProblem

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- MIN_BUF_SIZE
  
  static final int MIN_BUF_SIZE
  
  Let's size buffer at least big enough to contain the longest possible prefix of a document needed to positively identify it starts with the XML declaration. That means having (optional) BOM, and then first 6 characters ("invalid input: '<'?xml "), in whatever encoding. With 4-byte encodings (UCS-4), that comes to 28 bytes. And for good measure, let's pad that a bit as well....
  See Also:
  
  Constant Field Values
- mIn
  
  final InputStream mIn
  
  Underlying InputStream to use for reading content. May be null if the actual data source is not stream-based but a block source.
- mByteBuffer
  
  private byte[] mByteBuffer
- mRecycleBuffer
  
  private final boolean mRecycleBuffer
  
  Whether byte buffer is recyclable or not
- mInputPtr
  
  private int mInputPtr
- mInputEnd
  
  private int mInputEnd
- mBigEndian
  
  boolean mBigEndian
- mHadBOM
  
  boolean mHadBOM
- mByteSizeFound
  
  boolean mByteSizeFound
- mBytesPerChar
  
  int mBytesPerChar
  
  For most encodings, number of physical characters needed for decoding xml declaration characters (which for variable length encodings like UTF-8 will be 1). Exception is EBCDIC, which while a single-byte encoding, is denoted by -1 since it needs an additional translation lookup.
- mEBCDIC
  
  boolean mEBCDIC
  
  Special case for 1-byte encodings: EBCDIC is problematic as it's not 7-bit ascii compatible. We can deal with it, still, but only with bit of extra state.
- mInputEncoding
  
  String mInputEncoding
- mSingleByteTranslation
  
  int[] mSingleByteTranslation
  
  For single-byte non-ascii-compatible encodings (ok ok, really just EBCDIC), we'll have to use a lookup table.
Constructor Details
- StreamBootstrapper
  
  private StreamBootstrapper(String pubId, SystemId sysId, InputStream in)
- StreamBootstrapper
  
  private StreamBootstrapper(String pubId, SystemId sysId, byte[] data, int start, int end)
  
  Parameters:
  
  start - Pointer to the first valid byte in the buffer
  
  end - Pointer to the offset after last valid byte in the buffer
Method Details
- getInstance
  
  public static StreamBootstrapper getInstance(String pubId, SystemId sysId, InputStream in)
  
  Factory method used when the underlying data provider is an actual stream.
- getInstance
  
  public static StreamBootstrapper getInstance(String pubId, SystemId sysId, byte[] data, int start, int end)
  
  Factory method used when the underlying data provider is a pre-allocated block source, and no stream is used. Additionally the buffer passed is not owned by the bootstrapper or Reader that is created, so it is not to be recycled.
- bootstrapInput
  
  public Reader bootstrapInput(ReaderConfig cfg, boolean mainDoc, int xmlVersion) throws IOException, XMLStreamException
  
  Specified by:
  
  bootstrapInput in class InputBootstrapper
  
  Parameters:
  
  xmlVersion - 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.
  
  Throws:
  
  IOException
  
  XMLStreamException
- getInputEncoding
  
  public String getInputEncoding()
  
  Since this class only gets used when encoding is not explicitly passed, need use the encoding that was auto-detected...
  
  Specified by:
  
  getInputEncoding in class InputBootstrapper
  
  Returns:
  
  Input encoding in use, if it could be determined or was passed by the calling application
- getInputTotal
  
  public int getInputTotal()
  
  Specified by:
  
  getInputTotal in class InputBootstrapper
  
  Returns:
  
  Total number of characters read from bootstrapped input (stream, reader)
- getInputColumn
  
  public int getInputColumn()
  
  Specified by:
  
  getInputColumn in class InputBootstrapper
- resolveStreamEncoding
  
  protected void resolveStreamEncoding() throws IOException, WstxException
  
  Method called to try to figure out physical encoding the underlying input stream uses.
  
  Throws:
  
  IOException
  
  WstxException
- verifyXmlEncoding
  
  protected String verifyXmlEncoding(String enc) throws WstxException
  
  Returns:
  
  Normalized encoding name
  
  Throws:
  
  WstxException
- ensureLoaded
  
  protected boolean ensureLoaded(int minimum) throws IOException
  
  Throws:
  
  IOException
- loadMore
  
  protected void loadMore() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- pushback
  
  protected void pushback()
  
  Specified by:
  
  pushback in class InputBootstrapper
- getNext
  
  protected int getNext() throws IOException, WstxException
  
  Specified by:
  
  getNext in class InputBootstrapper
  
  Throws:
  
  IOException
  
  WstxException
- getNextAfterWs
  
  protected int getNextAfterWs(boolean reqWs) throws IOException, WstxException
  
  Specified by:
  
  getNextAfterWs in class InputBootstrapper
  
  Throws:
  
  IOException
  
  WstxException
- checkKeyword
  
  protected int checkKeyword(String exp) throws IOException, WstxException
  
  Specified by:
  
  checkKeyword in class InputBootstrapper
  
  Returns:
  
  First character that does not match expected, if any; CHAR_NULL if match succeeded
  
  Throws:
  
  IOException
  
  WstxException
- readQuotedValue
  
  protected int readQuotedValue(char[] outputBuffer, int quoteChar) throws IOException, WstxException
  
  Specified by:
  
  readQuotedValue in class InputBootstrapper
  
  Throws:
  
  IOException
  
  WstxException
- hasXmlDecl
  
  protected boolean hasXmlDecl() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- getLocation
  
  protected Location getLocation()
  
  Specified by:
  
  getLocation in class InputBootstrapper
- nextByte
  
  protected byte nextByte() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- skipSbWs
  
  protected int skipSbWs() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- skipSbLF
  
  protected void skipSbLF(byte lfByte) throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- checkSbKeyword
  
  protected int checkSbKeyword(String expected) throws IOException, WstxException
  
  Returns:
  
  First character that does not match expected, if any; CHAR_NULL if match succeeded
  
  Throws:
  
  IOException
  
  WstxException
- nextMultiByte
  
  protected int nextMultiByte() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- nextTranslated
  
  protected int nextTranslated() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- skipMbWs
  
  protected int skipMbWs() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- skipTranslatedWs
  
  protected int skipTranslatedWs() throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- skipMbLF
  
  protected void skipMbLF(int lf) throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- skipTranslatedLF
  
  protected void skipTranslatedLF(int lf) throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- checkMbKeyword
  
  protected int checkMbKeyword(String expected) throws IOException, WstxException
  
  Returns:
  
  First character that does not match expected, if any; CHAR_NULL if match succeeded
  
  Throws:
  
  IOException
  
  WstxException
- checkTranslatedKeyword
  
  protected int checkTranslatedKeyword(String expected) throws IOException, WstxException
  
  Throws:
  
  IOException
  
  WstxException
- verifyEncoding
  
  private void verifyEncoding(String id, int bpc) throws WstxException
  
  Throws:
  
  WstxException
- verifyEncoding
  
  private void verifyEncoding(String id, int bpc, boolean bigEndian) throws WstxException
  
  Throws:
  
  WstxException
- reportWeirdUCS4
  
  private void reportWeirdUCS4(String type) throws IOException
  
  Throws:
  
  IOException

Class StreamBootstrapper

Field Summary

Fields inherited from class com.ctc.wstx.io.InputBootstrapper

Constructor Summary

Method Summary

Methods inherited from class com.ctc.wstx.io.InputBootstrapper

Methods inherited from class java.lang.Object

Field Details

MIN_BUF_SIZE

mIn

mByteBuffer

mRecycleBuffer

mInputPtr

mInputEnd

mBigEndian

mHadBOM

mByteSizeFound

mBytesPerChar

mEBCDIC

mInputEncoding

mSingleByteTranslation

Constructor Details

StreamBootstrapper

StreamBootstrapper

Method Details

getInstance

getInstance

bootstrapInput

getInputEncoding

getInputTotal

getInputColumn

resolveStreamEncoding

verifyXmlEncoding

ensureLoaded

loadMore

pushback

getNext

getNextAfterWs

checkKeyword

readQuotedValue

hasXmlDecl

getLocation

nextByte

skipSbWs

skipSbLF

checkSbKeyword

nextMultiByte

nextTranslated

skipMbWs

skipTranslatedWs

skipMbLF

skipTranslatedLF

checkMbKeyword

checkTranslatedKeyword

verifyEncoding

verifyEncoding

reportWeirdUCS4