gradle-master/subprojects/core-api/src/main/java/org/gradle/internal/cache/MonitoredCleanupAction.java
/*
 * Copyright 2022 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.internal.cache;

import org.gradle.api.Describable;
import org.gradle.cache.CleanupProgressMonitor;

/**
 * An action that cleans up some resource and reports to a {@link CleanupProgressMonitor}.
 */
public interface MonitoredCleanupAction extends Describable {
    /**
     * Perform the cleanup action, returning true if any resources were actually cleaned up.
     *
     * @param progressMonitor
     * @return true if resources were cleaned
     */
    boolean execute(CleanupProgressMonitor progressMonitor);
}
