Package hudson.util

Class AtomicFileWriter

java.lang.Object

java.io.Writer

hudson.util.AtomicFileWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class AtomicFileWriter
extends Writer

Buffered FileWriter that supports atomic operations.

The write operation is atomic when used for overwriting; it either leaves the original file intact, or it completely rewrites it with new contents.

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AtomicFileWriter(File f)	Writes with UTF-8 encoding.
AtomicFileWriter(File f, String encoding)	Deprecated. Use AtomicFileWriter(Path, Charset)
AtomicFileWriter(Path destinationPath, Charset charset)
AtomicFileWriter(Path destinationPath, Charset charset, boolean integrityOnFlush, boolean integrityOnClose)	Deprecated. use AtomicFileWriter(Path, Charset)

Method Summary

Modifier and Type	Method	Description
void	abort()	When the write operation failed, call this method to leave the original file intact and remove the temporary file.
void	close()
void	commit()
void	flush()
File	getTemporaryFile()	Deprecated. Use getTemporaryPath()
Path	getTemporaryPath()	Until the data is committed, this file captures the written content.
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

AtomicFileWriter

public AtomicFileWriter(File f)
                 throws IOException

Writes with UTF-8 encoding.

Throws:

IOException

AtomicFileWriter

@Deprecated
public AtomicFileWriter(@NonNull
 File f,
 @Nullable
 String encoding)
                 throws IOException

Deprecated.

Use AtomicFileWriter(Path, Charset)

Parameters:

encoding - File encoding to write. If null, platform default encoding is chosen.

Throws:

IOException

AtomicFileWriter

public AtomicFileWriter(@NonNull
 Path destinationPath,
 @NonNull
 Charset charset)
                 throws IOException

Parameters:

destinationPath - the destination path where to write the content when committed.

charset - File charset to write.

Throws:

IOException

AtomicFileWriter

@Deprecated
public AtomicFileWriter(@NonNull
 Path destinationPath,
 @NonNull
 Charset charset,
 boolean integrityOnFlush,
 boolean integrityOnClose)
                 throws IOException

Deprecated.

use AtomicFileWriter(Path, Charset)

DO NOT USE THIS METHOD, OR YOU WILL LOSE DATA INTEGRITY.

Parameters:

destinationPath - the destination path where to write the content when committed.

charset - File charset to write.

integrityOnFlush - do not force writing to disk when flushing

integrityOnClose - do not force writing to disk when closing

Throws:

IOException

Method Details

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

abort

public void abort()
           throws IOException

When the write operation failed, call this method to leave the original file intact and remove the temporary file. This method can be safely invoked from the "finally" block, even after the commit() is called, to simplify coding.

Throws:

IOException

commit

public void commit()
            throws IOException

Throws:

IOException

getTemporaryFile

@Deprecated
public File getTemporaryFile()

Deprecated.

Use getTemporaryPath()

Until the data is committed, this file captures the written content.

getTemporaryPath

public Path getTemporaryPath()

Until the data is committed, this file captures the written content.

Since:

2.93