AtomicFile

Kotlin |Java

@UnstableApi
public final class AtomicFile

A helper class for performing atomic operations on a file by creating a backup file until a write has successfully completed.

Atomic file guarantees file integrity by ensuring that a file has been completely written and synced to disk before removing its backup. As long as the backup file exists, the original file is considered to be invalid (left over from a previous attempt to write the file).

Atomic file does not confer any file locking semantics. Do not use this class when the file may be accessed or modified concurrently by multiple threads or processes. The caller is responsible for ensuring appropriate mutual exclusion invariants whenever it accesses the file.

Summary

Public constructors
`AtomicFile(File baseName)` Create a new AtomicFile for a file located at the given File path.

Public methods
`void`	`delete()` Delete the atomic file.
`void`	`endWrite(OutputStream str)` Call when you have successfully finished writing to the stream returned by `startWrite`.
`boolean`	`exists()` Returns whether the file or its backup exists.
`InputStream`	`openRead()` Open the atomic file for reading.
`OutputStream`	`startWrite()` Start a new write operation on the file.

Public constructors

AtomicFile

public AtomicFile(File baseName)

Create a new AtomicFile for a file located at the given File path. The secondary backup file will be the same file path with ".bak" appended.

Public methods

delete

public void delete()

Delete the atomic file. This deletes both the base and backup files.

endWrite

public void endWrite(OutputStream str)

Call when you have successfully finished writing to the stream returned by startWrite. This will close, sync, and commit the new data. The next attempt to read the atomic file will return the new file stream.

Parameters
`OutputStream str`	Outer-most wrapper OutputStream used to write to the stream returned by `startWrite`.

Throws
`java.io.IOException`

See also
`startWrite`

exists

public boolean exists()

Returns whether the file or its backup exists.

openRead

public InputStream openRead()

Open the atomic file for reading. If there previously was an incomplete write, this will roll back to the last good data before opening for read.

Note that if another thread is currently performing a write, this will incorrectly consider it to be in the state of a bad write and roll back, causing the new data currently being written to be dropped. You must do your own threading protection for access to AtomicFile.

Throws
`java.io.FileNotFoundException`

startWrite

public OutputStream startWrite()

Start a new write operation on the file. This returns an OutputStream to which you can write the new file data. If the whole data is written successfully you must call endWrite. On failure you should call close only to free up resources used by it.

Example usage:

  DataOutputStream dataOutput = null;
  try {
    OutputStream outputStream = atomicFile.startWrite();
    dataOutput = new DataOutputStream(outputStream); // Wrapper stream
    dataOutput.write(data1);
    dataOutput.write(data2);
    atomicFile.endWrite(dataOutput); // Pass wrapper stream
  } finally{
    if (dataOutput != null) {
      dataOutput.close();
    }
  }

Note that if another thread is currently performing a write, this will simply replace whatever that thread is writing with the new file being written by this thread, and when the other thread finishes the write the new write operation will no longer be safe (or will be lost). You must do your own threading protection for access to AtomicFile.

Throws
`java.io.IOException`