Skip to content

pwssOrg/PWSS-DirectoryNav

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PWSS-DirectoryNav

Makefile CI SCA Scan - PWSS-DirectoryNav

A powerful and efficient library for traversing directories and subdirectories to retrieve file paths, tailored for applications like file integrity scanning within the PWSS family.

Overview

PWSS-DirectoryNav is designed to simplify directory navigation by providing an easy-to-use API that allows you to traverse through files in a given directory. This makes it ideal for use cases such as file integrity checks and other directory-related operations within the PWSS ecosystem.

Features

  • Efficient traversal of directories and subdirectories
  • Retrieval of file paths with ease
  • Suitable for file integrity scanning applications

Getting Started

Dependencies

To include this library in your project, add the following dependency to your pom.xml:

<dependency>
  <groupId>io.github.pwssorg</groupId>
  <artifactId>directory_nav</artifactId>
  <version>1.5.6</version>
</dependency>

MvnRepository

Basic Usage

java.io.File

Retrieving a Future List of File

import org.pwss.io_file.FileTraverser;
import org.pwss.io_file.FileTraverserImpl;

import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;

public class Main {
    public static void main(String[] args) throws IOException,
            ExecutionException,
            InterruptedException {
        FileTraverser fileTraverser = new FileTraverserImpl();

        Future<List<File>> future = fileTraverser
                .traverse("C:\\Users\\PWSS\\" +
                        "Downloads\\ShredChat-master\\ShredChat-master");
        while (!future.isDone()) {

        }
        List<File> fileList = future.get();
        fileList.forEach(f -> System.out.println(f.getAbsolutePath()));
        fileTraverser.shutdownThreadPool();
    }
}

Retrieving a List of files with no subfolders to the selected folder (static)

import org.pwss.util.PWSSDirectoryNavUtil;

import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.ExecutionException;

public class Main {

    public static void main(String[] args) throws IOException,
            ExecutionException,
            InterruptedException {
        File selectedFolder =
                new File("C:\\Program Files (x86)\\Battle.net");

        List<File> noSubfolderList = PWSSDirectoryNavUtil
                .GetSelectedFolderWithoutSubFolders(selectedFolder);
        noSubfolderList
                .forEach(file -> System.out.println(file.getAbsolutePath()));
    }
}

API Documentation

For detailed information about our classes, methods, and their usage, please visit the Javadoc:

Link to API Docs

The Javadocs provide comprehensive documentation for all public APIs in this project, including:

  • Class descriptions
  • Method details with parameters and return types
  • Example usages when available

drawing

Always traverse quickly and gracefully - only then can you achieve full file integrity

Discussion Forum

Please visit our discussion forum for project-related documentation and discussions: Project Discussion Forum


© 2026 pwssOrg. All rights reserved.

About

A library for traversing directories and subdirectories to collect file paths, used in file integrity scanning and other PWSS system components.

Topics

Resources

License

Stars

Watchers

Forks

Contributors