com.aspectran.utils.FileScanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectran-all Show documentation
Aspectran (All-in-One)
There is a newer version: 8.1.5
/*
 * Copyright (c) 2008-2024 The Aspectran Project
 *
 * 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 com.aspectran.utils;

import com.aspectran.utils.annotation.jsr305.NonNull;
import com.aspectran.utils.wildcard.WildcardMatcher;
import com.aspectran.utils.wildcard.WildcardPattern;

import java.io.File;
import java.util.LinkedHashMap;
import java.util.Map;

import static com.aspectran.utils.PathUtils.REGULAR_FILE_SEPARATOR_CHAR;

/**
 * A utility class that finds files corresponding to a given pattern.
 * Note that the file separator always uses a slash (/), regardless of the OS.
 *
 * @author Juho Jeong
 * @since 1.3.0
 */
public class FileScanner {

    private final String basePath;

    public FileScanner() {
        this(null);
    }

    public FileScanner(String basePath) {
        this.basePath = basePath;
    }

    public Map scan(String filePathPattern) {
        final Map scannedFiles = new LinkedHashMap<>();
        scan(filePathPattern, scannedFiles);
        return scannedFiles;
    }

    public void scan(String filePathPattern, @NonNull final Map scannedFiles) {
        scan(filePathPattern, scannedFiles::put);
    }

    public void scan(String filePathPattern, SaveHandler saveHandler) {
        if (filePathPattern == null) {
            throw new IllegalArgumentException("filePathPattern must not be null");
        }

        WildcardPattern pattern = WildcardPattern.compile(filePathPattern, REGULAR_FILE_SEPARATOR_CHAR);
        WildcardMatcher matcher = new WildcardMatcher(pattern);
        matcher.separate(filePathPattern);

        StringBuilder sb = new StringBuilder();
        while (matcher.hasNext()) {
            String term = matcher.next();
            if (!term.isEmpty()) {
                if (!WildcardPattern.hasWildcards(term)) {
                    if (!sb.isEmpty())
                        sb.append(REGULAR_FILE_SEPARATOR_CHAR);
                    sb.append(term);
                } else {
                    break;
                }
            } else {
                sb.append(REGULAR_FILE_SEPARATOR_CHAR);
            }
        }

        String basePath = sb.toString();
        scan(basePath, matcher, saveHandler);
    }

    public Map scan(String basePath, String filePathPattern) {
        final Map scannedFiles = new LinkedHashMap<>();
        scan(basePath, filePathPattern, scannedFiles);
        return scannedFiles;
    }

    public void scan(String basePath, String filePathPattern, @NonNull final Map scannedFiles) {
        scan(basePath, filePathPattern, scannedFiles::put);
    }

    public void scan(@NonNull String basePath, String filePathPattern, SaveHandler saveHandler) {
        WildcardPattern pattern = WildcardPattern.compile(filePathPattern, REGULAR_FILE_SEPARATOR_CHAR);
        WildcardMatcher matcher = new WildcardMatcher(pattern);
        if (basePath.charAt(basePath.length() - 1) == REGULAR_FILE_SEPARATOR_CHAR) {
            basePath = basePath.substring(0, basePath.length() - 1);
        }
        scan(basePath, matcher, saveHandler);
    }

    protected void scan(final String targetPath, final WildcardMatcher matcher, final SaveHandler saveHandler) {
        final File target;
        if (StringUtils.hasText(basePath)) {
            target = new File(basePath, targetPath);
        } else {
            target = new File(targetPath);
        }
        if (!target.exists()) {
            return;
        }
        target.listFiles(file -> {
            String filePath = targetPath + REGULAR_FILE_SEPARATOR_CHAR + file.getName();
            if (file.isDirectory()) {
                scan(filePath, matcher, saveHandler);
            } else {
                if (matcher.matches(filePath)) {
                    saveHandler.save(filePath, file);
                }
            }
            return false;
        });
    }

    public interface SaveHandler {

        void save(String filePath, File scannedFile);

    }

}