File Reading Documentation

Overview

This library provides utilities for reading file contents efficiently.

Package Structure

• io.github.astrapi69.file.read.api

  • Readable - Interface for reading file contents.

• io.github.astrapi69.file.read

  • ReadFileExtensions - Utility class for reading files.

---

Interfaces and Classes

Readable (Interface)

Defines methods for reading file contents.

Methods:

• fromFile(File file) - Reads a file with UTF-8 encoding and returns its content as a string.
• fromFile(File file, Charset encoding) - Reads a file with a specified encoding.
• readHeadLine(String inputFile) - Reads the first line from a file.
• readAllLines(File input) - Reads all lines from a file into a list.
• toByteArray(File tmpFile) - Reads a file into a byte array.
• toByteArray(InputStream input) - Converts an InputStream to a byte array.
• toObject(byte[] byteArray) - Converts a primitive byte array to a Byte array.

---

ReadFileExtensions

Utility class for reading file content.

Methods:

• getFilecontentAsByteObjectArray(File tmpFile) - Reads file content as a Byte object array.
• readFileToBytearray(File file) - Reads a file into a byte array.
• fromFile(File file) - Reads a file as a string (UTF-8 encoding).
• fromFile(File file, Charset encoding) - Reads a file as a string with a specified encoding.
• readHeadLine(String inputFile) - Reads the first line from a file.
• readLinesInList(File input) - Reads all lines from a file into a list.
• readLine(File input, int index) - Reads a specific line from a file.
• readPropertiesFromFile(String filename) - Reads a properties file into a Properties object.
• toByteArray(File tmpFile) - Reads file content into a byte array.
• toByteArray(InputStream input) - Converts an InputStream to a byte array.
• countAllLines(File fileToCountTheLines) - Counts the number of lines in a file.

---