Create New Files And Directories

Overview

The file-worker library provides a comprehensive set of tools for file and directory management in Java. It includes utilities for creating files, directories, and managing file contents efficiently.

Package Structure

• io.github.astrapi69.file.create.api

  • Createable - Interface defining methods for file and directory creation.

• io.github.astrapi69.file.create.model

  • FileContentInfo - Represents information about file content.
  • FileCreationState - Enum defining states for file creation.

• io.github.astrapi69.file.create

  • DirectoryFactory - Utility class for creating directories.
  • DirectoryStructureExtensions - Methods for extracting file information from directory structures.
  • DirectoryStructureFactory - Helps in constructing directory structures.
  • FileFactory - Utility class for file creation.

---

Interfaces and Classes

Createable (Interface)

Defines methods for creating files and directories.

Methods:

• newDirectories(Collection<File> directories) - Creates multiple directories.
• newDirectories(Path dir, FileAttribute<?>... attrs) - Creates directories with attributes.
• newDirectory(Path dir, FileAttribute<?>... attrs) - Creates a single directory.
• newDirectory(String absolutePath) - Creates a directory from a string path.
• mkParentDirs(File file) - Ensures parent directories exist.
• newFile(File file) - Creates a new file if it does not exist.
• newFile(String absolutePath) - Creates a new file from an absolute path.
• newFiles(Collection<File> files) - Creates multiple files.

---

FileContentInfo

Represents metadata of a file, including checksum and content.

Properties:

• checksum - Checksum of file content.
• content - Byte array of file content.

Methods:

• toFileContentInfo(File file) - Converts a File to FileContentInfo.
• toFile(FileContentInfo fileContentInfo) - Converts FileContentInfo to a File.

---

FileCreationState

Enum that represents the state of file creation.

States:

• ALREADY_EXISTS - The file already exists.
• CREATED - The file was successfully created.
• FAILED - The file creation failed.
• PENDING - The file creation is pending.

---

DirectoryFactory

Provides utility methods for creating directories.

Methods:

• newDirectories(Collection<File> directories) - Creates multiple directories.
• newDirectory(Path dir, FileAttribute<?>... attrs) - Creates a directory.
• newDirectory(File directory) - Creates a directory from a File object.
• newTempDirectory(String prefix, FileAttribute<?>... attrs) - Creates a temporary directory.

---

DirectoryStructureExtensions

Provides methods to retrieve file information from directory structures.

Methods:

• getFileContentInfos(File directory) - Retrieves FileContentInfo for all files in a directory.

---

DirectoryStructureFactory

Helps in creating directory structures.

Methods:

• newDirectoryStructure(Collection<FileContentInfo> fileInfos) - Creates a directory structure with file content.
• newDirectoryStructure(File parentDirectory, Collection<String> filePaths) - Creates a directory structure under a parent directory.

---

FileFactory

Provides utility methods for creating files.

Methods:

• newFile(File file) - Creates a new file.
• newFile(String absolutePath, boolean createIfNotExists) - Creates a file from an absolute path.
• newFile(File parentDirectory, String filename) - Creates a file inside a parent directory.

---