ImageRenamer.java

/*
 * Copyright 2026, Aiki IT, FotoRenamer
 * 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
 *
 * https://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 de.aikiit.fotorenamer.image;

import java.util.function.BooleanSupplier;
import java.util.function.Consumer;

/** UI-independent batch processing with cooperative cancellation between files. */
@FunctionalInterface
public interface ImageRenamer {
    RenameResult renameFiles(Consumer<RenameProgress> onProgress, BooleanSupplier cancellationRequested);

    default RenameResult renameFiles(Consumer<RenameProgress> onProgress) {
        return renameFiles(onProgress, () -> false);
    }

    default RenameResult renameFiles() {
        return renameFiles(progress -> { });
    }
}