Class UTF8Reader
java.lang.Object
java.io.Reader
com.fasterxml.jackson.dataformat.csv.impl.UTF8Reader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
Optimized Reader that reads UTF-8 encoded content from an input stream.
In addition to doing (hopefully) optimal conversion, it can also take
array of "pre-read" (leftover) bytes; this is necessary when preliminary
stream/reader is trying to figure out underlying character encoding.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private int
Total read byte count; used for error reporting purposesprivate int
Total read character count; used for error reporting purposesprivate int
Flag that is set when a pending decode error has been detected; needed to properly handle deferred reporting.private byte[]
private int
Pointed to the end marker, that is, position one after the last valid available byte.private int
Pointer to the next available byte (if any), iff less thanmByteBufferEnd
private InputStream
private final com.fasterxml.jackson.core.io.IOContext
IO context to use for returning input buffer, iff buffer is to be recycled when input ends.private int
Decoded first character of a surrogate pair, if one needs to be bufferedprivate char[]
-
Constructor Summary
ConstructorsConstructorDescriptionUTF8Reader
(com.fasterxml.jackson.core.io.IOContext ctxt, byte[] buf, int ptr, int len) UTF8Reader
(com.fasterxml.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose) UTF8Reader
(com.fasterxml.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose, byte[] buf, int ptr, int len) -
Method Summary
Modifier and TypeMethodDescriptionprotected final boolean
Method that can be used to see if we can actually modify the underlying buffer.void
close()
final void
This method should be called along with (or instead of) normal close.protected final InputStream
private boolean
loadMore
(int available) int
read()
Although this method is implemented by the base class, AND it should never be called by parser code, let's still implement it bit more efficiently just in caseint
read
(char[] cbuf) int
read
(char[] cbuf, int start, int len) protected final int
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
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
protected void
reportInvalidInitial
(int mask, int outputDecoded) protected void
reportInvalidOther
(int mask, int outputDecoded, int errorPosition) protected void
protected void
reportUnexpectedEOF
(int gotBytes, int needed) Methods inherited from class java.io.Reader
mark, markSupported, nullReader, read, ready, reset, skip, transferTo
-
Field Details
-
_ioContext
private final com.fasterxml.jackson.core.io.IOContext _ioContextIO context to use for returning input buffer, iff buffer is to be recycled when input ends. -
_inputSource
-
_autoClose
private final boolean _autoClose -
_inputBuffer
private byte[] _inputBuffer -
_inputPtr
private int _inputPtrPointer to the next available byte (if any), iff less thanmByteBufferEnd
-
_inputEnd
private int _inputEndPointed to the end marker, that is, position one after the last valid available byte. -
_surrogate
private int _surrogateDecoded first character of a surrogate pair, if one needs to be buffered -
_charCount
private int _charCountTotal read character count; used for error reporting purposes -
_byteCount
private int _byteCountTotal read byte count; used for error reporting purposes -
_decodeErrorOffset
private int _decodeErrorOffsetFlag that is set when a pending decode error has been detected; needed to properly handle deferred reporting. -
_tmpBuffer
private char[] _tmpBuffer
-
-
Constructor Details
-
UTF8Reader
public UTF8Reader(com.fasterxml.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose, byte[] buf, int ptr, int len) -
UTF8Reader
public UTF8Reader(com.fasterxml.jackson.core.io.IOContext ctxt, byte[] buf, int ptr, int len) -
UTF8Reader
-
-
Method Details
-
canModifyBuffer
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
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classReader
- Throws:
IOException
-
read
Although this method is implemented by the base class, AND it should never be called by parser code, let's still implement it bit more efficiently just in case- Overrides:
read
in classReader
- Throws:
IOException
-
read
- Overrides:
read
in classReader
- Throws:
IOException
-
read
- Specified by:
read
in classReader
- Throws:
IOException
-
getStream
-
readBytes
Method for reading as many bytes from the underlying stream as possible (that fit in the buffer), to the beginning of the buffer.- Throws:
IOException
-
readBytesAt
Method for reading as many bytes from the underlying stream as possible (that fit in the buffer considering offset), to the specified offset.- Returns:
- Number of bytes read, if any; -1 to indicate none available (that is, end of input)
- Throws:
IOException
-
freeBuffers
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). -
loadMore
- Parameters:
available
- Number of "unused" bytes in the input buffer- Returns:
- True, if enough bytes were read to allow decoding of at least one full character; false if EOF was encountered instead.
- Throws:
IOException
-
reportBounds
- Throws:
IOException
-
reportStrangeStream
- Throws:
IOException
-
reportInvalidInitial
- Throws:
IOException
-
reportInvalidOther
protected void reportInvalidOther(int mask, int outputDecoded, int errorPosition) throws IOException - Throws:
IOException
-
reportDeferredInvalid
- Throws:
IOException
-
reportUnexpectedEOF
- Throws:
IOException
-