Package org.kohsuke.stapler.framework.io

Class AtomicFileWriter

java.lang.Object

java.io.Writer

org.kohsuke.stapler.framework.io.AtomicFileWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class AtomicFileWriter
extends Writer

Buffered FileWriter that uses UTF-8.

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)

Method Summary

Modifier and Type	Method	Description
void	close()
void	commit()
void	flush()
File	getTemporaryFile()	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

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

commit

public void commit()
            throws IOException

Throws:

IOException

getTemporaryFile

public File getTemporaryFile()

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