/*
 * Copyright 2011 the original author or authors.
 *
 * 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 org.gradle.internal.resource.local;

import org.gradle.api.Action;

import java.io.File;

/**
 * An indexed store that maps a key to a file or directory.
 *
 * Most implementations do not provide locking, which must be coordinated by the caller.
 */
public interface FileStore<K> {
    /**
     * Moves the given file into the store.
     */
    LocallyAvailableResource move(K key, File source) throws FileStoreException;

    /**
     * Copies the given file into the store.
     */
    LocallyAvailableResource copy(K key, File source) throws FileStoreException;

    /**
     * Moves the contents of this store to the given destination.
     */
    void moveFilestore(File destination) throws FileStoreException;

    /**
     * Adds an entry to the store, using the given action to produce the file.
     *
     * @throws FileStoreAddActionException When the action fails
     * @throws FileStoreException On other failures
     */
    LocallyAvailableResource add(K key, Action<File> addAction) throws FileStoreException;
}
