fiftyone.pipeline.util.FileFinder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline.core Show documentation
There is a newer version: 4.5.0-alpha.1
/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

package fiftyone.pipeline.util;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Optional;

import static java.util.Objects.isNull;

public class FileFinder {
    /**
     * MAX depth to iterate when searching for files below specified root
     */
    public static int DEPTH_TO_SEARCH = 30;

    /**
     * Search for a resource (file) in a context {searchRoot}
     *
     * The file sought must end in the supplied string, where the components of the string
     * must wholly match the components of the location it is found in - per {@link Path#endsWith}
     *
     * When using this feature be aware that the first match is returned, not the closest in scope,
     * so try to use unique paths.
     *
     * @param file       the qualified name of the resource to find
     * @param searchRoot which part of the directory structure to search
     * @return a File representing the resource
     * @throws IllegalArgumentException if the resource can't be found
     */
    public static File getFilePath(String file, String searchRoot) {
        try {
            Optional p = Files.find(
                            Paths.get(searchRoot),
                            DEPTH_TO_SEARCH,
                            (path, a) -> path.endsWith(file))
                    .findFirst();
            if (p.isPresent()) {
                return p.get().toFile();
            }
        } catch (IOException e) {
            // drop through
        }
        throw new IllegalArgumentException("Cannot find " + file + " in " + searchRoot);
    }

    /**
     * Search (the project directory) for a resource. If it doesn't exist throw an exception.
     *
     * If the system property project.root has been set, probably in
     * the maven surefire plugin config, then this is set as the scope of the search,
     * otherwise the scope is system property user.dir (the directory Java was launched from).
     *
     * @param file the qualified name of the resource to find
     * @return a File representing the resource
     * @see #getFilePath(String, String)
     */
    public static File getFilePath(String file) {
        String searchRoot = isNull(System.getProperty("project.root")) ?
                System.getProperty("user.dir") :
                System.getProperty("project.root");
        return getFilePath(file, searchRoot);
    }
}