/*
 * Copyright 2020 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.execution.workspace;

import java.io.File;

public interface ImmutableWorkspaceProvider {
    ImmutableWorkspace getWorkspace(String path);

    interface ImmutableWorkspace {
        /**
         * Looks up the immutable workspace.
         */
        File getImmutableLocation();

        /**
         * Provides a temporary workspace and executes the given action in it.
         */
        <T> T withTemporaryWorkspace(TemporaryWorkspaceAction<T> action);

        @FunctionalInterface
        interface TemporaryWorkspaceAction<T> {
            T executeInTemporaryWorkspace(File temporaryWorkspaceLocation);
        }
    }
}
