org.gradle.cache.CacheRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * 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;

/**
 * A repository of persistent caches and stores. A store is a store for persistent data. A cache is a store for persistent
 * cache data. The only real difference between the two is that a store cannot be invalidated, whereas a cache can be invalidated when things
 * change. For example, running with {@code --cache rebuild} will invalidate the contents of all caches, but not the contents of any stores.
 */
public interface CacheRepository {
    /**
     * Returns a builder for the store with the given key and global scope. Default is a Gradle version-specific store shared by all builds, though this
     * can be changed using the provided builder.
     *
     * A store is always opened with a shared lock, so that it can be accessed by multiple processes. It is the caller's responsibility to
     * coordinate access to the cache.
     *
     * @param key The cache key. This is a unique identifier within the cache scope.
     * @return The builder.
     */
    CacheBuilder store(String key);

    /**
     * Returns a builder for the store with the given key and scope. Scope might be a Gradle, Project or Task.
     */
    CacheBuilder store(Object scope, String key);

    /**
     * Returns a builder for the cache with the given key and global scope. Default is a Gradle version-specific cache shared by all builds, though this
     * can be changed using the provided builder.
     *
     * A state cache is always opened with a shared lock, so that it can be accessed by multiple processes. It is the caller's responsibility
     * to coordinate access to the cache.
     *
     * @param key The cache key. This is a unique identifier within the cache scope.
     * @return The builder.
     */
    CacheBuilder cache(String key);

    /**
     * Returns a builder for the cache with the given base directory. You should prefer one of the other methods over using this method.
     */
    CacheBuilder cache(File baseDir);

    /**
     * Returns a builder for the cache with the given key and scope. Scope might be a Gradle, Project or Task.
     */
    CacheBuilder cache(Object scope, String key);
}