Package hudson.util

Class FileChannelWriter

java.lang.Object

java.io.Writer

hudson.util.FileChannelWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, Channel

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class FileChannelWriter
extends Writer
implements Channel

This class has been created to help make AtomicFileWriter hopefully more reliable in some corner cases. We created this wrapper to be able to access FileChannel.force(boolean) which seems to be one of the rare ways to actually have a guarantee that data be flushed to the physical device (only guaranteed for local, not for remote obviously though).

The goal using this is to reduce as much as we can the likeliness to see zero-length files be created in place of the original ones.

See Also:

JENKINS-34855, PR-2548

Field Summary

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
boolean	isOpen()
void	write(char[] cbuf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write, write, write

Methods inherited from class java.lang.Object

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

Method Detail

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

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException