com.palantir.giraffe.file.base.feature

Interface LargeFileCopy

public interface LargeFileCopy

Indicates that a FileSystemProvider supports efficient copying of large files.

Method Summary

Modifier and Type	Method and Description
void	copyLarge(Path source, Path target) Copies the source file to the target path in an efficient way.

Method Detail

copyLarge

void copyLarge(Path source,
               Path target)
        throws IOException

Copies the source file to the target path in an efficient way. An efficient mechanism is one that generally performs better than the default mechanism of streaming between two byte channels. 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 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