Jackson 3.0.1 · tools.jackson.dataformat.toml.UTF8Reader

Field Summary

Modifier and Type	Field and Description
private final boolean	_autoClose
private int	_byteCount Total read byte count; used for error reporting purposes
private int	_charCount Total read character count; used for error reporting purposes
private byte[]	_inputBuffer
private final boolean	_inputBufferReadOnly Flag set to indicate `inputBuffer` is read-only, and its content should not be modified.
private int	_inputEnd Pointed to the end marker, that is, position one after the last valid available byte.
private int	_inputPtr Pointer to the next available byte (if any), iff less than `mByteBufferEnd`
private InputStream	_inputSource
private final IOContext	_ioContext IO context to use for returning input buffer, iff buffer is to be recycled when input ends.
private int	_surrogate Decoded first character of a surrogate pair, if one needs to be buffered
private char[]	_tmpBuffer

Inherited from java.io.Reader:: lock

Constructor Summary

Access	Constructor and Description
private	UTF8Reader(IOContext ctxt, InputStream in, boolean autoClose, byte[] buf, int ptr, int end, boolean inputBufferReadOnly)

Method Summary

Modifier and Type	Method and Description
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 static UTF8Reader	construct(IOContext ctxt, InputStream in, boolean autoClose)
public static UTF8Reader	construct(byte[] buf, int ptr, int len)
private void	freeBuffers() This method should be called along with (or instead of) normal close.
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() Overrides java.io.Reader.read. Reads a single character.
public int	read(char[] cbuf) Overrides java.io.Reader.read. Reads characters into an array.
public int	read(final char[] cbuf, final int start, int len) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.
protected final int	readBytes()
protected final int	readBytesAt(int offset)
protected void	reportBounds(char[] cbuf, int start, int len)
private void	reportInvalidInitial(int mask, int offset)
private void	reportInvalidOther(int mask, int offset)
protected void	reportStrangeStream()
private void	reportUnexpectedEOF(int gotBytes, int needed)

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

Field Detail

_autoClose	back to summary
private final boolean _autoClose

_byteCount	back to summary
private int _byteCount Total read byte count; used for error reporting purposes

_charCount	back to summary
private int _charCount Total read character count; used for error reporting purposes

_inputBuffer	back to summary
private byte[] _inputBuffer

_inputBufferReadOnly back to summary

_inputBufferReadOnly	back to summary
private final boolean _inputBufferReadOnly Flag set to indicate `inputBuffer` is read-only, and its content should not be modified. This is the case when caller has passed in a buffer of contents already read, instead of Jackson allocating read buffer. Since 2.20

private final boolean _inputBufferReadOnly

Flag set to indicate inputBuffer is read-only, and its content should not be modified. This is the case when caller has passed in a buffer of contents already read, instead of Jackson allocating read buffer.

Since: 2.20

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

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

_inputSource	back to summary
private InputStream _inputSource

_ioContext	back to summary
private final IOContext _ioContext IO context to use for returning input buffer, iff buffer is to be recycled when input ends.

_surrogate	back to summary
private int _surrogate Decoded first character of a surrogate pair, if one needs to be buffered

_tmpBuffer	back to summary
private char[] _tmpBuffer

Constructor Detail

UTF8Reader	back to summary
private UTF8Reader(IOContext ctxt, InputStream in, boolean autoClose, byte[] buf, int ptr, int end, boolean inputBufferReadOnly)

Method Detail

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

construct	back to summary
public static UTF8Reader construct(IOContext ctxt, InputStream in, boolean autoClose)

construct	back to summary
public static UTF8Reader construct(byte[] buf, int ptr, int len)

freeBuffers	back to summary
private 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).

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
public int read() throws IOException Overrides java.io.Reader.read. Doc from java.io.Reader.read. Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached. Subclasses that intend to support efficient single-character input should override this method. Annotations @Override Exceptions IOException: If an I/O error occurs

read

back to summary

public int read() throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached.

Subclasses that intend to support efficient single-character input should override this method.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf) throws IOException Overrides java.io.Reader.read. Doc from java.io.Reader.read. Reads characters into 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 the length of `cbuf` 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`. Annotations @Override Exceptions IOException: If an I/O error occurs

public int read(char[] cbuf) throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into 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 the length of cbuf 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.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(final char[] cbuf, final 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`. Annotations @Override Exceptions IOException: If an I/O error occurs

public int read(final char[] cbuf, final 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.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

readBytes	back to summary
protected final int readBytes() throws IOException

readBytesAt	back to summary
protected final int readBytesAt(int offset) throws IOException

reportBounds	back to summary
protected void reportBounds(char[] cbuf, int start, int len) throws IOException

reportInvalidInitial	back to summary
private void reportInvalidInitial(int mask, int offset) throws IOException

reportInvalidOther	back to summary
private void reportInvalidOther(int mask, int offset) throws IOException

reportStrangeStream	back to summary
protected void reportStrangeStream() throws IOException

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

public final Class UTF8Reader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail