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

Field Summary

Modifier and Type	Field and Description
protected final boolean	mBigEndian
protected int	mByteCount Total read byte count; used for error reporting purposes
protected int	mCharCount Total read character count; used for error reporting purposes
protected char	mSurrogate Although input is fine with full Unicode set, Java still uses 16-bit chars, so we may have to split high-order chars into surrogate pairs.
protected boolean	mXml11

Inherited from com.ctc.wstx.io.BaseReader:: CHAR_DEL CONVERT_LSEP_TO CONVERT_NEL_TO mByteBuffer mByteBufferEnd mBytePtr mConfig mTmpBuf NULL_BYTE NULL_CHAR

Constructor Summary

Access	Constructor and Description
public	UTF32Reader(ReaderConfig cfg, InputStream in, byte[] buf, int ptr, int len, boolean recycleBuffer, boolean isBigEndian)

Method Summary

Modifier and Type	Method and Description
private boolean	Returns: True, if enough bytes were read to allow decoding of at least one full character; false if EOF was encountered instead. loadMore(int Number of "unused" bytes in the input buffer available)
public int	read(char[] Destination buffer cbuf, int Offset at which to start storing characters start, int Maximum number of characters to read len) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.
private void	reportInvalid(int value, int offset, String msg)
private void	reportUnexpectedEOF(int gotBytes, int needed)
public void	setXmlCompliancy(int xmlVersion) Implements abstract com.ctc.wstx.io.BaseReader.setXmlCompliancy. Method that can be called to indicate the xml conformance used when reading content using this reader.

Inherited from com.ctc.wstx.io.BaseReader:: canModifyBuffer close freeBuffers getStream read readBytes readBytesAt reportBounds reportInvalidXml11 reportStrangeStream

Field Detail

mBigEndian	back to summary
protected final boolean mBigEndian

mByteCount	back to summary
protected int mByteCount Total read byte count; used for error reporting purposes

mCharCount	back to summary
protected int mCharCount Total read character count; used for error reporting purposes

mSurrogate	back to summary
protected char mSurrogate Although input is fine with full Unicode set, Java still uses 16-bit chars, so we may have to split high-order chars into surrogate pairs.

mXml11	back to summary
protected boolean mXml11

Constructor Detail

UTF32Reader	back to summary
public UTF32Reader(ReaderConfig cfg, InputStream in, byte[] buf, int ptr, int len, boolean recycleBuffer, boolean isBigEndian)

Method Detail

loadMore	back to summary
private boolean loadMore(int available) throws IOException Parameters available:int Number of "unused" bytes in the input buffer Returns:boolean True, if enough bytes were read to allow decoding of at least one full character; false if EOF was encountered instead.

read back to summary

read	back to summary
public int read(char[] cbuf, int start, int len) throws IOException Implements abstract java.io.Reader.read. Doc from java.io.Reader.read. Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. If `len` is zero, then no characters are read and `0` is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value `-1` is returned; otherwise, at least one character is read and stored into `cbuf`. Parameters cbuf:char[] Destination buffer start:int Offset at which to start storing characters len:int Maximum number of characters to read Returns:int The number of characters read, or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public int read(char[] cbuf, int start, int len) throws IOException

Implements abstract java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

If len is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters

cbuf:char[]: Destination buffer
start:int: Offset at which to start storing characters
len:int: Maximum number of characters to read

Returns:int

The number of characters read, or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

reportInvalid	back to summary
private void reportInvalid(int value, int offset, String msg) throws IOException

reportUnexpectedEOF	back to summary
private void reportUnexpectedEOF(int gotBytes, int needed) throws IOException

setXmlCompliancy	back to summary
public void setXmlCompliancy(int xmlVersion) Implements abstract com.ctc.wstx.io.BaseReader.setXmlCompliancy. Doc from com.ctc.wstx.io.BaseReader.setXmlCompliancy. Method that can be called to indicate the xml conformance used when reading content using this reader. Some of the character validity checks need to be done at reader level, and sometimes they depend on xml level (for example, xml 1.1 has new linefeeds and both more and less restricted characters). Annotations @Override

setXmlCompliancy

back to summary

public void setXmlCompliancy(int xmlVersion)

Implements abstract com.ctc.wstx.io.BaseReader.setXmlCompliancy.

Doc from com.ctc.wstx.io.BaseReader.setXmlCompliancy.

Method that can be called to indicate the xml conformance used when reading content using this reader. Some of the character validity checks need to be done at reader level, and sometimes they depend on xml level (for example, xml 1.1 has new linefeeds and both more and less restricted characters).