File Renaming Documentation

Overview

This library provides utilities for renaming and moving files and directories efficiently.

Package Structure

• io.github.astrapi69.file.rename.api

  • Renameable - Interface defining methods for renaming files and directories.

• io.github.astrapi69.file.rename

  • RenameFileExtensions - Utility class for renaming and moving files.

---

Interfaces and Classes

Renameable (Interface)

Defines methods for renaming files and directories.

Methods:

• appendSystemTimeToFilename(File fileToRename) - Appends the system time to a filename.
• appendSystemTimeToFilename(File fileToRename, Date add2Name) - Appends a specific date to a filename.
• changeAllFilenameSuffix(File file, String oldSuffix, String newSuffix, boolean delete) - Changes the suffix of multiple files in a directory.
• changeFilenameSuffix(File file, String newSuffix, boolean delete) - Changes the suffix of a file.
• renameFile(File fileToRename, File newFileName, boolean delete) - Renames a file, with an option to delete the original.
• renameFileWithSystemtime(File fileToRename) - Renames a file and appends the system time.
• forceToMoveFile(File srcFile, File destinationFile) - Moves a file to a new location.
• moveFile(File srcFile, File destDir) - Moves a file to a directory.

---

RenameFileExtensions

Provides static utility methods for renaming files and directories.

Methods:

• appendSystemtimeToFilename(File fileToRename) - Appends system time to a filename.
• changeAllFilenameSuffix(File file, String oldSuffix, String newSuffix, boolean delete) - Changes the suffix of all matching files.
• changeFilenameSuffix(File file, String newSuffix, boolean delete) - Changes the suffix of a file.
• renameFile(File fileToRename, File newFileName, boolean delete) - Renames a file.
• renameFileWithSystemtime(File fileToRename) - Renames a file with the system time.
• forceToMoveFile(File srcFile, File destinationFile) - Moves a file to a new location.
• moveFile(File srcFile, File destDir) - Moves a file to a new directory.

---