Class StorageFile

  • All Implemented Interfaces:
    Comparable<StorageFile>, FileReader, FileWriter

    public final class StorageFile
    extends Object
    implements Comparable<StorageFile>, FileWriter
    Encapsulates the idea of a file for writing data to and then later updating the original.
    Author:
    jesse
    • Constructor Detail

    • Method Detail

      • getFile

        public File getFile()
        Returns the storage file
        Returns:
        the storage file
      • getWriteChannel

        public FileChannel getWriteChannel()
                                    throws IOException
        Throws:
        IOException
      • replaceOriginal

        public void replaceOriginal()
                             throws IOException
        Replaces the file that the temporary file is acting as a transactional type cache for. Acts similar to a commit.
        Throws:
        IOException
        See Also:
        replaceOriginals(StorageFile...)
      • replaceOriginals

        public static void replaceOriginals​(StorageFile... storageFiles)
                                     throws IOException
        Takes a collection of StorageFiles and performs the replace functionality described in replaceOriginal(). However, all files that are part of the same ShpFiles are done within a lock so all of the updates for all the Files of a Shapefile can be updated within a single lock.
        Parameters:
        storageFiles - files to execute the replace functionality.
        Throws:
        IOException
      • compareTo

        public int compareTo​(StorageFile o)
        Just groups together files that have the same ShpFiles instance
        Specified by:
        compareTo in interface Comparable<StorageFile>
      • toString

        public String toString()
        Overrides:
        toString in class Object
      • id

        public String id()
        Description copied from interface: FileWriter
        An id for the writer. This is only used for debugging.
        Specified by:
        id in interface FileReader
        Specified by:
        id in interface FileWriter
        Returns:
        id for the writer.