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

Field Summary

Modifier and Type	Field and Description
pack-priv static final char	CHAR_DEL DEL character is both the last ascii char, and illegal in xml 1.1.
protected static final char	CONVERT_LSEP_TO In xml 1.1, LSEP bit like \n, or \r. Need to choose one as the result.
protected static final char	CONVERT_NEL_TO In xml 1.1, NEL (0x85) behaves much the way \n does (can be follow \r as part of the linefeed
protected byte[]	mByteBuffer
protected int	mByteBufferEnd Pointed to the end marker, that is, position one after the last valid available byte.
protected int	mBytePtr Pointer to the next available byte (if any), iff less than `mByteBufferEnd`
protected final ReaderConfig	mConfig
private InputStream	mIn
private final boolean	mRecycleBuffer Flag that indicates whether the read buffer is to be recycled when Reader is closed or not.
protected char[]	mTmpBuf
protected static final char	NULL_BYTE
protected static final char	NULL_CHAR

Inherited from java.io.Reader:: lock

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
protected final boolean	canModifyBuffer() Method that can be used to see if we can actually modify the underlying buffer.
public void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
public final void	freeBuffers() This method should be called along with (or instead of) normal close.
protected final InputStream	getStream()
public int	read() Overrides java.io.Reader.read. Although this method is implemented by the base class, AND it should never be called by Woodstox code, let's still implement it bit more efficiently just in case
protected final int	readBytes() Method for reading as many bytes from the underlying stream as possible (that fit in the buffer), to the beginning of the buffer.
protected final int	Returns: Number of bytes read, if any; -1 to indicate none available (that is, end of input) readBytesAt(int offset) Method for reading as many bytes from the underlying stream as possible (that fit in the buffer considering offset), to the specified offset.
protected void	reportBounds(char[] cbuf, int start, int len)
protected void	reportInvalidXml11(int value, int bytePos, int charPos)
protected void	reportStrangeStream()
public abstract void	setXmlCompliancy(int xmlVersion) Method that can be called to indicate the xml conformance used when reading content using this reader.

Inherited from java.io.Reader:: mark markSupported nullReader read read read ready reset skip transferTo

Field Detail

CHAR_DEL	back to summary
pack-priv static final char CHAR_DEL DEL character is both the last ascii char, and illegal in xml 1.1.

CONVERT_LSEP_TO	back to summary
protected static final char CONVERT_LSEP_TO In xml 1.1, LSEP bit like \n, or \r. Need to choose one as the result. Let's use \n, for simplicity

CONVERT_NEL_TO	back to summary
protected static final char CONVERT_NEL_TO In xml 1.1, NEL (0x85) behaves much the way \n does (can be follow \r as part of the linefeed

mByteBuffer	back to summary
protected byte[] mByteBuffer

mByteBufferEnd	back to summary
protected int mByteBufferEnd Pointed to the end marker, that is, position one after the last valid available byte.

mBytePtr	back to summary
protected int mBytePtr Pointer to the next available byte (if any), iff less than `mByteBufferEnd`

mConfig	back to summary
protected final ReaderConfig mConfig

mIn	back to summary
private InputStream mIn

mRecycleBuffer	back to summary
private final boolean mRecycleBuffer Flag that indicates whether the read buffer is to be recycled when Reader is closed or not.

mTmpBuf	back to summary
protected char[] mTmpBuf

NULL_BYTE	back to summary
protected static final char NULL_BYTE

NULL_CHAR	back to summary
protected static final char NULL_CHAR

Constructor Detail

BaseReader	back to summary
protected BaseReader(ReaderConfig cfg, InputStream in, byte[] buf, int ptr, int len, boolean recycleBuffer)

Method Detail

canModifyBuffer	back to summary
protected final boolean canModifyBuffer() Method that can be used to see if we can actually modify the underlying buffer. This is the case if we are managing the buffer, but not if it was just given to us.

close	back to summary
public void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

freeBuffers	back to summary
public final void freeBuffers() This method should be called along with (or instead of) normal close. After calling this method, no further reads should be tried. Method will try to recycle read buffers (if any).

getStream	back to summary
protected final InputStream getStream()

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. Although this method is implemented by the base class, AND it should never be called by Woodstox code, let's still implement it bit more efficiently just in case Returns:int Doc from java.io.Reader.read. The character read, as an integer in the range 0 to 65535 (`0x00-0xffff`), or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: Doc from java.io.Reader.read. If an I/O error occurs

public int read() throws IOException

Overrides java.io.Reader.read.

Although this method is implemented by the base class, AND it should never be called by Woodstox code, let's still implement it bit more efficiently just in case

Returns:int

Doc from java.io.Reader.read.

The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Reader.read.

If an I/O error occurs

readBytes	back to summary
protected final int readBytes() throws IOException Method for reading as many bytes from the underlying stream as possible (that fit in the buffer), to the beginning of the buffer.

readBytesAt	back to summary
protected final int readBytesAt(int offset) throws IOException Method for reading as many bytes from the underlying stream as possible (that fit in the buffer considering offset), to the specified offset. Returns:int Number of bytes read, if any; -1 to indicate none available (that is, end of input)

readBytesAt