/*
 * Copyright 2025 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;

public interface FineGrainedCacheBuilder {

    /**
     * Specifies the display name for this cache. This display name is used in logging and error messages.
     */
    FineGrainedCacheBuilder withDisplayName(String displayName);

    /**
     * Specifies a cleanup strategy.
     */
    FineGrainedCacheBuilder withCleanupStrategy(FineGrainedCacheCleanupStrategy cacheCleanupStrategy);

    /**
     * Opens the cache. It is the caller's responsibility to close the cache when finished with it.
     *
     * Cache will always use {@link FileLockManager.LockMode#OnDemandEagerRelease} lock mode for key locks.
     */
    FineGrainedPersistentCache open() throws CacheOpenException;
}
