Package org.apache.iotdb.tsfile.read.reader

Interface TsFileInput

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void close()
      Closes this channel.
      java.lang.String getFilePath()  
      long position()
      Returns this input's current position.
      TsFileInput position​(long newPosition)
      Sets this input's position.
      int read​(java.nio.ByteBuffer dst)
      Reads a sequence of bytes from this TsFileInput into the given buffer.
      int read​(java.nio.ByteBuffer dst, long position)
      Reads a sequence of bytes from this TsFileInput into the given buffer, starting at the given position.
      default java.lang.String readVarIntString​(long offset)
      read a string from the Input at the given position
      long size()
      Returns the current size of this input.
      java.io.InputStream wrapAsInputStream()  

    • Method Detail

      • size

        long size()
   throws java.io.IOException
        Returns the current size of this input.
        Returns:
        The current size of this input, measured in bytes
        Throws:
        java.nio.channels.ClosedChannelException - If this channel is closed
        java.io.IOException - If some other I/O error occurs

      • position

        long position()
       throws java.io.IOException
        Returns this input's current position.
        Returns:
        This input's current position, a non-negative integer counting the number of bytes from the beginning of the input to the current position
        Throws:
        java.nio.channels.ClosedChannelException - If this input is closed
        java.io.IOException - If some other I/O error occurs

      • position

        TsFileInput position​(long newPosition)
              throws java.io.IOException
        Sets this input's position.

        Setting the position to a value that is greater than the input's current size is legal but does not change the size of the TsFileInput. A later attempt to read bytes at such a position will immediately return an end-of-file indication.

        Parameters:
        newPosition - The new position, a non-negative integer counting the number of bytes from the beginning of the TsFileInput
        Returns:
        This TsFileInput
        Throws:
        java.nio.channels.ClosedChannelException - If this TsFileInput is closed
        java.lang.IllegalArgumentException - If the new position is negative
        java.io.IOException - If some other I/O error occurs

      • read

        int read​(java.nio.ByteBuffer dst)
  throws java.io.IOException
        Reads a sequence of bytes from this TsFileInput into the given buffer.

        Bytes are read starting at this TsFileInput's current position, and then the position is updated with the number of bytes actually read. Otherwise this method behaves exactly as specified in the ReadableByteChannel interface.

        Throws:
        java.io.IOException

      • read

        int read​(java.nio.ByteBuffer dst,
         long position)
  throws java.io.IOException
        Reads a sequence of bytes from this TsFileInput into the given buffer, starting at the given position.

        This method works in the same manner as the read(ByteBuffer) method, except that bytes are read starting at the given position rather than at the TsFileInput's current position. This method does not modify this TsFileInput's position. If the given position is greater than the TsFileInput's current size then no bytes are read.

        Parameters:
        dst - The buffer into which bytes are to be transferred
        position - The position at which the transfer is to begin; must be non-negative
        Returns:
        The number of bytes read, possibly zero, or -1 if the given position is greater than or equal to the file's current size
        Throws:
        java.lang.IllegalArgumentException - If the position is negative
        java.nio.channels.ClosedChannelException - If this TsFileInput is closed
        java.nio.channels.AsynchronousCloseException - If another thread closes this TsFileInput while the read operation is in progress
        java.nio.channels.ClosedByInterruptException - If another thread interrupts the current thread while the read operation is in progress, thereby closing the channel and setting the current thread's interrupt status
        java.io.IOException - If some other I/O error occurs

      • wrapAsInputStream

        java.io.InputStream wrapAsInputStream()
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • close

        void close()
    throws java.io.IOException
        Closes this channel.

        If the channel has already been closed then this method returns immediately.

        Throws:
        java.io.IOException - If an I/O error occurs

      • readVarIntString

        default java.lang.String readVarIntString​(long offset)
                                   throws java.io.IOException
        read a string from the Input at the given position
        Throws:
        java.io.IOException

      • getFilePath

        java.lang.String getFilePath()