org.eclipse.core.internal.preferences

Class SafeFileOutputStream

java.lang.Object

java.io.OutputStream

org.eclipse.core.internal.preferences.SafeFileOutputStream

All Implemented Interfaces:

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

public class SafeFileOutputStream
extends java.io.OutputStream

This class should be used when there's a file already in the destination and we don't want to lose its contents if a failure writing this stream happens. Basically, the new contents are written to a temporary location. If everything goes OK, it is moved to the right place. This class handles buffering of output stream contents. Copied from org.eclipse.core.internal.localstore.SafeFileOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	EXTENSION
protected boolean	failed
protected java.io.OutputStream	output
protected java.io.File	target
protected java.io.File	temp

Constructor Summary

Constructors

Constructor and Description
SafeFileOutputStream(java.io.File file) Creates an output stream on a file at the given location

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	commit()
protected void	copy(java.io.File sourceFile, java.io.File destinationFile)
void	flush()
java.lang.String	getTempFilePath()
protected void	transferStreams(java.io.InputStream source, java.io.OutputStream destination)
void	write(int b)

Methods inherited from class java.io.OutputStream

write, write

Methods inherited from class java.lang.Object

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

Field Detail

temp

protected java.io.File temp

target

protected java.io.File target

output

protected java.io.OutputStream output

failed

protected boolean failed

EXTENSION

protected static final java.lang.String EXTENSION

See Also:

Constant Field Values

Constructor Detail

SafeFileOutputStream

public SafeFileOutputStream(java.io.File file)
                     throws java.io.IOException

Creates an output stream on a file at the given location

Parameters:

file - The file to be written to

Throws:

java.io.IOException

Method Detail

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

commit

protected void commit()
               throws java.io.IOException

Throws:

java.io.IOException

copy

protected void copy(java.io.File sourceFile,
                    java.io.File destinationFile)
             throws java.io.IOException

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

getTempFilePath

public java.lang.String getTempFilePath()

transferStreams

protected void transferStreams(java.io.InputStream source,
                               java.io.OutputStream destination)
                        throws java.io.IOException

Throws:

java.io.IOException

write

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

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException