Package org.apache.thrift.transport

Class TSimpleFileTransport

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public final class TSimpleFileTransport
extends TTransport
    Basic file support for the TTransport interface

    • Constructor Summary

      Constructors 
      Constructor Description
      TSimpleFileTransport​(java.lang.String path)
      Create a transport backed by a simple read only disk file (implicitly opens file)
      TSimpleFileTransport​(java.lang.String path, boolean read, boolean write)
      Create a transport backed by a simple file Implicitly opens file to conform to C++ behavior.
      TSimpleFileTransport​(java.lang.String path, boolean read, boolean write, boolean openFile)
      Create a transport backed by a simple file

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Close file, subsequent read/write activity will throw exceptions
      long getFilePointer()
      Return current file pointer position in bytes from beginning of file
      boolean isOpen()
      Test file status
      long length()
      Return the length of the file in bytes
      void open()
      Open file if not previously opened.
      int read​(byte[] buf, int off, int len)
      Read up to len many bytes into buf at offset
      void seek​(long offset)
      Move file pointer to specified offset, new read/write calls will act here
      void write​(byte[] buf, int off, int len)
      Write len many bytes from buff starting at offset

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TSimpleFileTransport

        public TSimpleFileTransport​(java.lang.String path,
                            boolean read,
                            boolean write,
                            boolean openFile)
                     throws TTransportException
        Create a transport backed by a simple file
        Parameters:
        path - the path to the file to open/create
        read - true to support read operations
        write - true to support write operations
        openFile - true to open the file on construction
        Throws:
        TTransportException - if file open fails

      • TSimpleFileTransport

        public TSimpleFileTransport​(java.lang.String path,
                            boolean read,
                            boolean write)
                     throws TTransportException
        Create a transport backed by a simple file Implicitly opens file to conform to C++ behavior.
        Parameters:
        path - the path to the file to open/create
        read - true to support read operations
        write - true to support write operations
        Throws:
        TTransportException - if file open fails

      • TSimpleFileTransport

        public TSimpleFileTransport​(java.lang.String path)
                     throws TTransportException
        Create a transport backed by a simple read only disk file (implicitly opens file)
        Parameters:
        path - the path to the file to open/create
        Throws:
        TTransportException - if file open fails

    • Method Detail

      • isOpen

        public boolean isOpen()
        Test file status
        Specified by:
        isOpen in class TTransport
        Returns:
        true if open, otherwise false

      • close

        public void close()
        Close file, subsequent read/write activity will throw exceptions
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class TTransport

      • read

        public int read​(byte[] buf,
                int off,
                int len)
         throws TTransportException
        Read up to len many bytes into buf at offset
        Specified by:
        read in class TTransport
        Parameters:
        buf - houses bytes read
        off - offset into buff to begin writing to
        len - maximum number of bytes to read
        Returns:
        number of bytes actually read
        Throws:
        TTransportException - on read failure

      • write

        public void write​(byte[] buf,
                  int off,
                  int len)
           throws TTransportException
        Write len many bytes from buff starting at offset
        Specified by:
        write in class TTransport
        Parameters:
        buf - buffer containing bytes to write
        off - offset into buffer to begin writing from
        len - number of bytes to write
        Throws:
        TTransportException - on write failure

      • seek

        public void seek​(long offset)
          throws TTransportException
        Move file pointer to specified offset, new read/write calls will act here
        Parameters:
        offset - bytes from beginning of file to move pointer to
        Throws:
        TTransportException - is seek fails

      • getFilePointer

        public long getFilePointer()
                    throws TTransportException
        Return current file pointer position in bytes from beginning of file
        Returns:
        file pointer position
        Throws:
        TTransportException - if file access fails