/*
 * Copyright 2009 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.cache;

import java.io.File;

/**
 * Represents a directory which can be used for caching.
 */
public interface PersistentCache {
    /**
     * Returns the base directory for this cache.
     */
    File getBaseDir();

    /**
     * Returns true if this cache is valid. If the cache is valid, its contents can be used. If not, the base directory
     * will be empty, and the cache contents must be rebuilt. You must call {@link #markValid} to indicate that the
     * contents have been rebuilt.
     */
    boolean isValid();

    /**
     * Marks the contents of the cache as valid.
     */
    void markValid();

    /**
     * Opens an indexed cache backed by this cache.
     *
     * @param serializer The serializer to use to serialise the cache entries.
     * @return The cache.
     */
    <K, V> PersistentIndexedCache<K, V> openIndexedCache(Serializer<V> serializer);

    /**
     * Opens an indexed cache backed by this cache.
     *
     * @return The cache.
     */
    <K, V> PersistentIndexedCache<K, V> openIndexedCache();

    /**
     * Opens a state cache backed by this cache.
     *
     * @return The cache.
     */
    <T> PersistentStateCache<T> openStateCache();
}
