/*
 * Copyright 2017 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.caching.internal.controller;

import org.gradle.caching.BuildCacheKey;

import java.io.IOException;
import java.io.InputStream;

public interface BuildCacheLoadCommand<T> {

    BuildCacheKey getKey();

    /**
     * Called at-most-once to initiate loading the artifact from the input stream.
     *
     * The input stream will be closed by this method.
     */
    Result<T> load(InputStream inputStream) throws IOException;

    interface Result<T> {

        /**
         * The number of entries in the loaded artifact.
         *
         * This is used as a rough metric of the complexity of the archive for processing
         * (in conjunction with the archive size).
         *
         * The meaning of “entry” is intentionally loose.
         */
        long getArtifactEntryCount();

        /**
         * Any metadata about the loaded artifact.
         *
         * Value may not be null.
         */
        T getMetadata();

    }

}
