com.palantir.giraffe.file.base.feature

Interface RecursiveCopy

public interface RecursiveCopy

Indicates that a FileSystemProvider supports efficient recursive copies.

Method Summary

Modifier and Type	Method and Description
void	copyRecursive(Path source, Path target) Recursively copies the source path to the target path in an efficient way.

Method Detail

copyRecursive

void copyRecursive(Path source,
                   Path target)
            throws IOException

Recursively copies the source path to the target path in an efficient way. An efficient mechanism is one that generally performs better than the default mechanism of recursively listing the source path and copying each file using the standard methods. For example, it is often possible to optimize copies between the default file system and a custom file system.

At least one of source or target will be associated with a FileSystem from this provider. If this method cannot efficiently copy between the given paths, it throws UnsupportedOperationException, indicating that the caller should fall back to another mechanism.

Parameters:

source - the path to the file or directory to copy

target - the target path

Throws:

UnsupportedOperationException - if this implementation does not support copies between a given source-target pair

IOException - if an I/O error occurs while copying