/file-searcher

Searches for files.

Primary LanguageJavaMIT LicenseMIT

File Searcher

Searches for files.

Coverage status Java compatibility Maven Central release License


❇ Introduction

File Searcher searches for files simply and easily.

❓ How to use

  1. Add one of the options below to the pom.xml file:

Using Maven Central (recomended):

<dependency>
  <groupId>io.github.wniemiec-io-java</groupId>
  <artifactId>file-searcher</artifactId>
  <version>LATEST</version>
</dependency>

Using GitHub Packages:

<dependency>
  <groupId>wniemiec.io.java</groupId>
  <artifactId>file-searcher</artifactId>
  <version>LATEST</version>
</dependency>
  1. Run
$ mvn install
  1. Use it
[...]

import wniemiec.io.java.FileSearcher;

[...]

Path workingDirectory = Path.of(".", "src", "test", "java");
FileSearcher searcher = new FileSearcher(workingDirectory);

Path file = searcher.search("FileSearcherTest.java");

System.out.println( file.toAbsolutePath() );

[...]

📖 Documentation

Property Parameter type Return type Description Default parameter value
searchAllFilesWithExtension extension: String Set<Path> Searches for all files with an extension starting from the specified working directory -
search filename: String Path Searches for a file starting from the specified working directory -

🚩 Changelog

Details about each version are documented in the releases section.

🤝 Contribute!

See the documentation on how you can contribute to the project here.

📁 Files

/

Name Type Description
dist Directory Released versions
docs Directory Documentation files
src Directory Source files