/*
 * Copyright 2024 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 org.gradle.internal.service.scopes.Scope;
import org.gradle.internal.service.scopes.ServiceScope;

import java.util.function.Supplier;

/**
 * Creates CacheCleanupStrategy instances.
 *
 * This may add decorations to the given CleanupActions to generate build operations, logging, etc.
 */
@ServiceScope(Scope.Global.class)
public interface CacheCleanupStrategyFactory {
    /**
     * Creates a CacheCleanupStrategy that cleans up the cache daily using the provided action.
     */
    CacheCleanupStrategy daily(CleanupAction action);

    /**
     * Creates a CacheCleanupStrategy that cleans up the cache using the provided action and frequency.
     */
    CacheCleanupStrategy create(CleanupAction action, Supplier<CleanupFrequency> frequency);
}
