Package org.eclipse.aether.util

Class FileUtils

java.lang.Object

org.eclipse.aether.util.FileUtils

public final class FileUtils
extends Object

A utility class to write files.

Since:

1.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileUtils.CollocatedTempFile	A collocated temporary file, that resides next to a "target" file, and is removed when closed.
static interface	FileUtils.FileWriter	A file writer, that accepts a Path to write some content to.
static interface	FileUtils.TempFile	A temporary file, that is removed when closed.

Method Summary

Modifier and Type	Method	Description
static FileUtils.TempFile	newTempFile()	Creates a FileUtils.TempFile.
static FileUtils.CollocatedTempFile	newTempFile(Path file)	Creates a FileUtils.TempFile for given file.
static void	writeFile(Path target, FileUtils.FileWriter writer)	Writes file without backup.
static void	writeFileWithBackup(Path target, FileUtils.FileWriter writer)	Writes file with backup copy (appends ".bak" extension).

Methods inherited from class java.lang.Object

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

Method Details

newTempFile

public static FileUtils.TempFile newTempFile()
                                      throws IOException

Creates a FileUtils.TempFile. It will be in the default temporary-file directory. Returned instance should be handled in try-with-resource construct and created temp file is removed on close, if exists.

Throws:

IOException

newTempFile

public static FileUtils.CollocatedTempFile newTempFile(Path file)
                                                throws IOException

Creates a FileUtils.TempFile for given file. It will be in same directory where given file is, and will reuse its name for generated name. Returned instance should be handled in try-with-resource construct and created temp file once ready can be moved to passed in file parameter place.

The file nor it's parent directories have to exist. The parent directories are created if needed.

Throws:

IOException

writeFile

public static void writeFile(Path target,
 FileUtils.FileWriter writer)
                      throws IOException

Writes file without backup.

Parameters:

target - that is the target file (must be file, the path must have parent).

writer - the writer that will accept a Path to write content to.

Throws:

IOException - if at any step IO problem occurs.

writeFileWithBackup

public static void writeFileWithBackup(Path target,
 FileUtils.FileWriter writer)
                                throws IOException

Writes file with backup copy (appends ".bak" extension).

Parameters:

target - that is the target file (must be file, the path must have parent).

writer - the writer that will accept a Path to write content to.

Throws:

IOException - if at any step IO problem occurs.