Package com.intellij.util.io

Class SafeFileOutputStream

java.lang.Object

java.io.OutputStream

com.intellij.util.io.SafeFileOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class SafeFileOutputStream
extends java.io.OutputStream

Attempts to prevent data loss if OS crash happens during write.

The class creates a backup copy before overwriting the target file, and issues fsync() afterwards. The behavior is based on an assumption that after a crash either a target remains unmodified (i.e. unfinished write doesn't reach the disc), or a backup file exists along with a partially overwritten target file.

The class is not thread-safe; expected to be used within try-with-resources or an equivalent statement.

Constructor Summary

Constructors

Constructor and Description
SafeFileOutputStream(java.io.File target)
SafeFileOutputStream(java.io.File target, java.lang.String backupExt)
SafeFileOutputStream(java.nio.file.Path target)
SafeFileOutputStream(java.nio.file.Path target, java.lang.String backupExt)

Method Summary

Modifier and Type	Method and Description
void	abort()
void	close()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SafeFileOutputStream

public SafeFileOutputStream(java.io.File target)

SafeFileOutputStream

public SafeFileOutputStream(java.io.File target,
                            java.lang.String backupExt)

SafeFileOutputStream

public SafeFileOutputStream(java.nio.file.Path target)

SafeFileOutputStream

public SafeFileOutputStream(java.nio.file.Path target,
                            java.lang.String backupExt)

Method Detail

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

abort

public void abort()
           throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException