Android Dev Summit, October 23-24: two days of technical content, directly from the Android team. Sign-up for livestream updates.

AtomicFile

open class AtomicFile
kotlin.Any
   ↳ androidx.core.util.AtomicFile

Static library support version of the framework's android.util.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 sync'd 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

<init>(@NonNull baseName: File)

Create a new AtomicFile for a file located at the given File path.

Public methods

open Unit

Delete the atomic file.

open Unit
failWrite(@Nullable str: FileOutputStream?)

Call when you have failed for some reason at writing to the stream returned by startWrite().

open Unit
finishWrite(@Nullable str: FileOutputStream?)

Call when you have successfully finished writing to the stream returned by startWrite().

open File

Return the path to the base file.

open FileInputStream

Open the atomic file for reading.

open ByteArray

A convenience for openRead() that also reads all of the file contents into a byte array which is returned.

open FileOutputStream

Start a new write operation on the file.

Public constructors

<init>

AtomicFile(@NonNull baseName: File)

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

open fun delete(): Unit

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

failWrite

open fun failWrite(@Nullable str: FileOutputStream?): Unit

Call when you have failed for some reason at writing to the stream returned by startWrite(). This will close the current write stream, and roll back to the previous state of the file.

finishWrite

open fun finishWrite(@Nullable str: FileOutputStream?): Unit

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.

getBaseFile

@NonNull open fun getBaseFile(): File

Return the path to the base file. You should not generally use this, as the data at that path may not be valid.

openRead

@NonNull open fun openRead(): FileInputStream

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. You should call close() on the FileInputStream when you are done reading from it.

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.

readFully

@NonNull open fun readFully(): ByteArray

A convenience for openRead() that also reads all of the file contents into a byte array which is returned.

startWrite

@NonNull open fun startWrite(): FileOutputStream

Start a new write operation on the file. This returns a FileOutputStream to which you can write the new file data. The existing file is replaced with the new data. You must not directly close the given FileOutputStream; instead call either finishWrite(FileOutputStream) or failWrite(FileOutputStream).

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.