org.kohsuke.stapler.framework.io

Class AtomicFileWriter

java.lang.Object

java.io.Writer

org.kohsuke.stapler.framework.io.AtomicFileWriter

All Implemented Interfaces:

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

public class AtomicFileWriter
extends java.io.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 and Description
AtomicFileWriter(java.io.File f)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	commit()
void	flush()
java.io.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(java.lang.String str, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomicFileWriter

public AtomicFileWriter(java.io.File f)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

write

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

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
         int off,
         int len)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

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

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

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

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

commit

public void commit()
            throws java.io.IOException

Throws:

java.io.IOException

getTemporaryFile

public java.io.File getTemporaryFile()

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