com.palantir.giraffe.file.base.feature.LargeFileCopy Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2015 Palantir Technologies, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.palantir.giraffe.file.base.feature;

import java.io.IOException;
import java.nio.file.Path;

/**
 * Indicates that a {@code FileSystemProvider} supports efficient copying of
 * large files.
 *
 * @author alake
 */
public interface LargeFileCopy {

    /**
     * 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 {@code source} or {@code target} will be associated with
     * a {@code FileSystem} from this provider. If this method cannot
     * efficiently copy between the given paths, it throws
     * {@code UnsupportedOperationException}, indicating that the caller should
     * fall back to another mechanism.
     *
     * @param source the path to the file to copy
     * @param target the target path
     *
     * @throws UnsupportedOperationException if this implementation does not
     *         support copies between a given {@code source}-{@code target} pair
     * @throws IOException if an I/O error occurs while copying
     */
    void copyLarge(Path source, Path target) throws IOException;
}