Index (ModuleSizeCalculator 1.0.0 API)

A

analyze() - Method in class pl.tfij.test.modulesize.ModuleSizeCalculator.ModuleSizeCalculatorBuilder: Analyzes the modules using the provided configuration and returns a summary of the project.

createMermaidPieChart() - Method in class pl.tfij.test.modulesize.ProjectSummary: Generates a Mermaid pie chart representation based on analyzed modules.

equals(Object) - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Indicates whether some other object is "equal to" this one.

hashCode() - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Returns a hash code value for this object.

include(String...) - Method in class pl.tfij.test.modulesize.ModuleSizeCalculator.ModuleSizeCalculatorBuilder: Set the set of file extensions that should be included in the analysis.

linesOfCode() - Method in class pl.tfij.test.modulesize.ProjectSummary
linesOfCode() - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Returns the value of the linesOfCode record component.

moduleName() - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Returns the value of the moduleName record component.
ModuleSizeCalculator - Class in pl.tfij.test.modulesize: The ModuleSizeCalculator class calculates the size of modules in a project.
ModuleSizeCalculator.ModuleSizeCalculatorBuilder - Class in pl.tfij.test.modulesize: The ModuleSizeCalculatorBuilder class provides a fluent API for configuring modules and analyzing projects.
ModuleSizeCalculatorException - Exception in pl.tfij.test.modulesize: The ModuleSizeCalculatorException class represents an exception that can occur during the calculation of module sizes.
modulesSummary() - Method in class pl.tfij.test.modulesize.ProjectSummary: Generates a summary of the analyzed modules.
ModuleSummary(String, int, int, double) - Constructor for record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Creates an instance of a ModuleSummary record class.

numberOfFiles() - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Returns the value of the numberOfFiles record component.
numberOfFiles() - Method in class pl.tfij.test.modulesize.ProjectSummary

pl.tfij.test.modulesize - package pl.tfij.test.modulesize
project(String) - Static method in class pl.tfij.test.modulesize.ModuleSizeCalculator: Creates a new ModuleSizeCalculatorBuilder instance for a project located at the specified root directory.
ProjectSummary - Class in pl.tfij.test.modulesize: The ProjectSummary class provides methods for analyzing and summarizing project modules.
ProjectSummary.ModuleSummary - Record Class in pl.tfij.test.modulesize

relativeSize() - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Returns the value of the relativeSize record component.

saveMermaidPieChart(Path) - Method in class pl.tfij.test.modulesize.ProjectSummary: Saves the Mermaid pie chart representation of the project summary to the specified target path.

toString() - Method in record class pl.tfij.test.modulesize.ProjectSummary.ModuleSummary: Returns a string representation of this record class.

verifyEachModuleRelativeSizeIsSmallerThan(double) - Method in class pl.tfij.test.modulesize.ProjectSummary: Verifies that the relative size of each moduleName is smaller than the given threshold.
verifyModuleRelativeSizeIsSmallerThan(String, double) - Method in class pl.tfij.test.modulesize.ProjectSummary: Verifies that the relative size of the specified moduleName is smaller than the given threshold.
verifyNoEmptyModules() - Method in class pl.tfij.test.modulesize.ProjectSummary: Verifies whether none of the defined modules is empty.
verifyUndefinedModuleNumberOfFilesIsSmallerThan(int) - Method in class pl.tfij.test.modulesize.ProjectSummary: Verifies that the number of files in the undefined moduleName is smaller than the specified allowedFileCount.

withDirModule(String) - Method in class pl.tfij.test.modulesize.ModuleSizeCalculator.ModuleSizeCalculatorBuilder: Adds a directory module to the list of modules for analysis.
withModule(String) - Method in class pl.tfij.test.modulesize.ModuleSizeCalculator.ModuleSizeCalculatorBuilder: Adds a moduleName package to the list of modules for analysis.