File Comparison Documentation

Overview

The File Comparison package is part of the file-worker Library and provides utilities to compare files based on various attributes such as name, extension, size, last modified date, absolute path, and content. This documentation describes the available classes and interfaces used to perform file comparisons.

Package

This functionality is contained within the io.github.astrapi69.file.compare package of the file-worker library.

Interfaces

IFileCompareResultBean

This interface defines the methods required to compare file attributes.

Methods:

• boolean getAbsolutePathEquality() - Checks if the absolute paths of the files are the same.
• void setAbsolutePathEquality(Boolean absolutePathEquality) - Sets the absolute path equality result.
• boolean getFileExtensionEquality() - Checks if the file extensions are the same.
• void setFileExtensionEquality(Boolean fileExtensionEquality) - Sets the file extension equality result.
• File getFileToCompare() - Retrieves the file being compared.
• boolean getLastModifiedEquality() - Checks if the last modified timestamps are the same.
• void setLastModifiedEquality(Boolean lastModifiedEquality) - Sets the last modified equality result.
• boolean getLengthEquality() - Checks if the file sizes are the same.
• void setLengthEquality(Boolean lengthEquality) - Sets the length equality result.
• boolean getNameEquality() - Checks if the file names are the same.
• void setNameEquality(Boolean nameEquality) - Sets the name equality result.
• File getSourceFile() - Retrieves the source file.

IFileContentResultBean

This interface extends IFileCompareResultBean and adds functionality to compare file contents.

Methods:

• boolean getContentEquality() - Checks if the contents of the files are the same.
• void setContentEquality(boolean contentEquality) - Sets the content equality result.

Implementations

FileCompareResultBean

This class implements IFileCompareResultBean and stores the comparison results for two files.

Constructor:

• FileCompareResultBean(File source, File compare) - Creates a new result bean for the specified files.

Additional Methods:

• Standard equals, hashCode, and toString implementations.

FileContentResultBean

This class extends FileCompareResultBean and implements IFileContentResultBean, adding functionality for content comparison.

Constructor:

• FileContentResultBean(File source, File compare) - Creates a new result bean for content comparison.

Utility Classes

CompareFileExtensions

This utility class provides methods to compare files based on various attributes.

Methods:

• void compare(IFileCompareResultBean fileCompareResultBean, boolean ignoreAbsolutePathEquality, boolean ignoreExtensionEquality, boolean ignoreLengthEquality, boolean ignoreLastModified, boolean ignoreNameEquality) - Compares two files based on the specified parameters.
• void compare(IFileContentResultBean fileContentResultBean, boolean ignoreAbsolutePathEquality, boolean ignoreExtensionEquality, boolean ignoreLengthEquality, boolean ignoreLastModified, boolean ignoreNameEquality, boolean ignoreContentEquality) - Compares file contents in addition to file attributes.
• IFileContentResultBean compareFileContentByBytes(File sourceFile, File fileToCompare) - Compares two files byte by byte.
• IFileContentResultBean compareFileContentByLines(File sourceFile, File fileToCompare) - Compares two files line by line.
• IFileContentResultBean compareFiles(File sourceFile, File fileToCompare) - Compares two files using default settings.
• IFileCompareResultBean compareFiles(File sourceFile, File fileToCompare, boolean ignoreAbsolutePathEquality, boolean ignoreExtensionEquality, boolean ignoreLengthEquality, boolean ignoreLastModified, boolean ignoreNameEquality) - Compares files with custom comparison parameters.
• boolean validateEquality(IFileCompareResultBean fileCompareResultBean) - Validates whether the files are equal based on file attributes.
• boolean validateEquality(IFileContentResultBean fileContentResultBean) - Validates whether the files are completely equal, including content.
• List<IFileCompareResultBean> findEqualFiles(File dirToSearch) - Searches for equal files within a directory.
• List<IFileContentResultBean> findEqualFilesWithSameContent(File dirToSearch) - Searches for files with identical content in a directory.

SimpleCompareFileExtensions

This utility class provides simple comparison methods for files.

Methods:

• boolean compareFilesByAbsolutePath(File sourceFile, File fileToCompare) - Compares files by their absolute paths.
• boolean compareFilesByChecksum(File sourceFile, File fileToCompare, Algorithm algorithm) - Compares files using a specified checksum algorithm.
• boolean compareFilesByChecksumAdler32(File sourceFile, File fileToCompare) - Compares files using the Adler-32 checksum.
• boolean compareFilesByChecksumCRC32(File sourceFile, File fileToCompare) - Compares files using the CRC-32 checksum.
• boolean compareFilesByContent(File sourceFile, File fileToCompare) - Compares files based on content.
• boolean compareFilesByExtension(File sourceFile, File fileToCompare) - Compares files based on extension.
• boolean compareFilesByLastModified(File sourceFile, File fileToCompare) - Compares files based on last modified date.
• boolean compareFilesByLength(File sourceFile, File fileToCompare) - Compares files based on file size.
• boolean compareFilesByName(File sourceFile, File fileToCompare) - Compares files based on file names.