File Writing Documentation

Overview

This library provides utilities for writing, storing, and appending file content.

Package Structure

• io.github.astrapi69.file.write.api

  • Storable - Interface defining methods for storing file contents.

• io.github.astrapi69.file.write

  • LineAppender - Utility class for appending lines to files.
  • StoreFileExtensions - Utility class for storing file contents.
  • WriteFileExtensions - Utility class for writing and modifying files.

---

Interfaces and Classes

Storable (Interface)

Defines methods for storing and updating file contents.

Methods:

• toFile(File file, byte[] data) - Stores a byte array to a file.
• toFile(File file, String stringToWrite) - Writes a string to a file.
• toFile(File file, Collection<String> lines) - Writes a collection of lines to a file.
• toFile(File file, Collection<String> lines, Charset charset) - Writes lines to a file with encoding.
• toFile(File file, String stringToWrite, Charset charset) - Writes a string to a file with encoding.

---

LineAppender

Provides methods for appending lines to files.

Methods:

• appendLines(File file, String... lineToAppend) - Appends lines to a file.

---

StoreFileExtensions

Provides methods for storing file content.

Methods:

• toFile(File file, byte[] data) - Stores a byte array in a file.
• toFile(File file, String stringToWrite) - Stores a string in a file.
• toFile(File file, Collection<String> lines) - Stores a collection of lines in a file.
• toFile(File file, Collection<String> lines, Charset charset) - Stores lines in a file with encoding.
• toFile(File file, String stringToWrite, Charset charset) - Stores a string in a file with encoding.

---

WriteFileExtensions

Provides static utility methods for writing and modifying files.

Methods:

• appendLines(File file, String... lineToAppend) - Appends lines to a file.
• readSourceFileAndWriteDestFile(String srcfile, String destFile) - Reads from a file and writes to another file.
• write2File(String stringToWrite, String nameOfFile) - Writes a string to a file.
• write(InputStream inputStream, OutputStream outputStream) - Writes data from an input stream to an output stream.
• writeLinesToFile(Collection<String> lines, File output, String encoding) - Writes lines to a file with a specified encoding.
• writeProperties2File(String filename, Properties properties) - Writes properties to a file.

---