Module tools.jackson.dataformat.csv
Package tools.jackson.dataformat.csv.impl

Class UTF8Reader

java.lang.Object
java.io.Reader
tools.jackson.dataformat.csv.impl.UTF8Reader
All Implemented Interfaces:
Closeable, AutoCloseable, Readable
public final class UTF8Reader extends Reader
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

    Fields
    Modifier and Type
    Field
    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 int
    _decodeErrorOffset
    Flag that is set when a pending decode error has been detected; needed to properly handle deferred reporting.
    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 tools.jackson.core.io.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
     

    Fields inherited from class java.io.Reader

    lock

  • Constructor Summary

    Constructors
    Constructor
    Description
    UTF8Reader(tools.jackson.core.io.IOContext ctxt, byte[] buf, int ptr, int len)
     
    UTF8Reader(tools.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose)
     
    UTF8Reader(tools.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose, byte[] buf, int ptr, int len)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    final void
    freeBuffers()
    This method should be called along with (or instead of) normal close.
    protected final InputStream
    getStream()
     
    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 case
    int
    read(char[] cbuf)
     
    int
    read(char[] cbuf, int start, int len)
     
    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
    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
    reportDeferredInvalid()
     
    protected void
    reportInvalidInitial(int mask, int outputDecoded)
     
    protected void
    reportInvalidOther(int mask, int outputDecoded, int errorPosition)
     
    protected void
    reportStrangeStream()
     
    protected void
    reportUnexpectedEOF(int gotBytes, int needed)
     

    Methods inherited from class java.io.Reader

    mark, markSupported, nullReader, read, ready, reset, skip, transferTo

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • _ioContext

      private final tools.jackson.core.io.IOContext _ioContext
      IO context to use for returning input buffer, iff buffer is to be recycled when input ends.

    • _inputSource

      private InputStream _inputSource

    • _autoClose

      private final boolean _autoClose

    • _inputBuffer

      private byte[] _inputBuffer

    • _inputBufferReadOnly

      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.19

    • _inputPtr

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

    • _inputEnd

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

    • _surrogate

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

    • _charCount

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

    • _byteCount

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

    • _decodeErrorOffset

      private int _decodeErrorOffset
      Flag 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(tools.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose, byte[] buf, int ptr, int len)

    • UTF8Reader

      public UTF8Reader(tools.jackson.core.io.IOContext ctxt, byte[] buf, int ptr, int len)

    • UTF8Reader

      public UTF8Reader(tools.jackson.core.io.IOContext ctxt, InputStream in, boolean autoClose)

  • Method Details

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Reader
      Throws:
      IOException

    • read

      public int read() throws IOException
      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 class Reader
      Throws:
      IOException

    • read

      public int read(char[] cbuf) throws IOException
      Overrides:
      read in class Reader
      Throws:
      IOException

    • read

      public int read(char[] cbuf, int start, int len) throws IOException
      Specified by:
      read in class Reader
      Throws:
      IOException

    • getStream

      protected final InputStream getStream()

    • readBytes

      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.
      Throws:
      IOException

    • readBytesAt

      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:
      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

      private boolean loadMore(int available) throws IOException
      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

      protected void reportBounds(char[] cbuf, int start, int len) throws IOException
      Throws:
      IOException

    • reportStrangeStream

      protected void reportStrangeStream() throws IOException
      Throws:
      IOException

    • reportInvalidInitial

      protected void reportInvalidInitial(int mask, int outputDecoded) throws IOException
      Throws:
      IOException

    • reportInvalidOther

      protected void reportInvalidOther(int mask, int outputDecoded, int errorPosition) throws IOException
      Throws:
      IOException

    • reportDeferredInvalid

      protected void reportDeferredInvalid() throws IOException
      Throws:
      IOException

    • reportUnexpectedEOF

      protected void reportUnexpectedEOF(int gotBytes, int needed) throws IOException
      Throws:
      IOException