Package org.eclipse.aether.spi.io

Interface PathProcessor

All Known Implementing Classes:

PathProcessorSupport

public interface PathProcessor

A utility component to perform file-based operations.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PathProcessor.CollocatedTempFile	A collocated temporary file, that resides next to a "target" file, and is removed when closed.
static interface	PathProcessor.ProgressListener	A listener object that is notified for every progress made while copying files.
static interface	PathProcessor.TempFile	A temporary file, that is removed when closed.

Method Summary

Modifier and Type	Method	Description
default void	copy(Path source, Path target)	Copies the specified source file to the given target file.
long	copy(Path source, Path target, PathProcessor.ProgressListener listener)	Copies the specified source file to the given target file.
default void	copyWithTimestamp(Path source, Path target)	Same as copy(Path, Path) but sets source file last modified timestamp on target as well.
default long	lastModified(Path path, long defValue)	Returns last modified of path in milliseconds, if exists.
void	move(Path source, Path target)	Moves the specified source file to the given target file.
PathProcessor.TempFile	newTempFile()	Creates a PathProcessor.TempFile instance and backing temporary file on file system.
PathProcessor.CollocatedTempFile	newTempFile(Path file)	Creates a PathProcessor.CollocatedTempFile instance for given file without backing file.
boolean	setLastModified(Path path, long value)	Sets last modified of path in milliseconds, if exists.
default long	size(Path path, long defValue)	Returns size of file, if exists.
void	write(Path target, InputStream source)	Writes the given stream to a file.
void	write(Path target, String data)	Writes the given data to a file.
void	writeWithBackup(Path target, InputStream source)	Writes the given stream to a file.
void	writeWithBackup(Path target, String data)	Writes the given data to a file.

Method Details

lastModified

default long lastModified(Path path,
 long defValue)

Returns last modified of path in milliseconds, if exists.

Parameters:

path - The path, may be null.

Throws:

UncheckedIOException - If an I/O error occurs.

setLastModified

boolean setLastModified(Path path,
 long value)
                 throws IOException

Sets last modified of path in milliseconds, if exists.

Parameters:

path - The path, may be null.

Throws:

IOException - If an I/O error occurs. Some exceptions/reasons of failure to set mtime may be swallowed, and can be multiple, ranging from "file not found" to cases when FS does not support the setting the mtime.

Since:

2.0.0

size

default long size(Path path,
 long defValue)

Returns size of file, if exists.

Parameters:

path - The path, may be null.

Throws:

UncheckedIOException - If an I/O error occurs.

write

void write(Path target,
 String data)
    throws IOException

Writes the given data to a file. UTF-8 is assumed as encoding for the data. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

target - The file to write to, must not be null. This file will be overwritten.

data - The data to write, may be null.

Throws:

IOException - If an I/O error occurs.

write

void write(Path target,
 InputStream source)
    throws IOException

Writes the given stream to a file. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

target - The file to write to, must not be null. This file will be overwritten.

source - The stream to write to the file, must not be null.

Throws:

IOException - If an I/O error occurs.

writeWithBackup

void writeWithBackup(Path target,
 String data)
              throws IOException

Writes the given data to a file. UTF-8 is assumed as encoding for the data. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

target - The file to write to, must not be null. This file will be overwritten.

data - The data to write, may be null.

Throws:

IOException - If an I/O error occurs.

Since:

2.0.13

writeWithBackup

void writeWithBackup(Path target,
 InputStream source)
              throws IOException

Writes the given stream to a file. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

target - The file to write to, must not be null. This file will be overwritten.

source - The stream to write to the file, must not be null.

Throws:

IOException - If an I/O error occurs.

Since:

2.0.13

move

void move(Path source,
 Path target)
   throws IOException

Moves the specified source file to the given target file. If the target file already exists, it is overwritten. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

source - The file to move from, must not be null.

target - The file to move to, must not be null.

Throws:

IOException - If an I/O error occurs.

copy

default void copy(Path source,
 Path target)
           throws IOException

Copies the specified source file to the given target file. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

source - The file to copy from, must not be null.

target - The file to copy to, must not be null.

Throws:

IOException - If an I/O error occurs.

copyWithTimestamp

default void copyWithTimestamp(Path source,
 Path target)
                        throws IOException

Same as copy(Path, Path) but sets source file last modified timestamp on target as well.

Parameters:

source - The file to copy from, must not be null.

target - The file to copy to, must not be null.

Throws:

IOException - If an I/O error occurs.

Since:

2.0.0

See Also:

• setLastModified(Path, long)

copy

long copy(Path source,
 Path target,
 PathProcessor.ProgressListener listener)
   throws IOException

Copies the specified source file to the given target file. Creates the necessary directories for the target file. In case of an error, the created directories will be left on the file system.

Parameters:

source - The file to copy from, must not be null.

target - The file to copy to, must not be null.

listener - The listener to notify about the copy progress, may be null.

Returns:

The number of copied bytes.

Throws:

IOException - If an I/O error occurs.

newTempFile

PathProcessor.TempFile newTempFile()
                            throws IOException

Creates a PathProcessor.TempFile instance and backing temporary file on file system. It will be located in the default temporary-file directory. Returned instance should be handled in try-with-resource construct and created temp file is removed (if exists) when returned instance is closed.

This method uses Files.createTempFile(String, String, java.nio.file.attribute.FileAttribute[]) to create the temporary file on file system.

Throws:

IOException

Since:

2.0.13

newTempFile

PathProcessor.CollocatedTempFile newTempFile(Path file)
                                      throws IOException

Creates a PathProcessor.CollocatedTempFile instance for given file without backing file. The path will be located in same directory where given file is, and will reuse its name for generated (randomized) name. Returned instance should be handled in try-with-resource and created temp path is removed (if exists) when returned instance is closed. The PathProcessor.CollocatedTempFile.move() makes possible to atomically replace passed in file with the processed content written into a file backing the PathProcessor.CollocatedTempFile instance.

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

This method uses Path.resolve(String) to create the temporary file path in passed in file parent directory, but it does NOT create backing file on file system.

Throws:

IOException

Since:

2.0.13