🧵 OpenLoom

The intelligent file reader for Java — blazing fast, zero config, and async-ready.

🔍 Read any file. 🧠 Choose the best method. 🚀 Perform like a pro.

---

✨ Why Use OpenLoom?

✅ Zero Config – Just drop in and start reading files.
✅ Adaptive Engine – Chooses the best reading method based on file size.
✅ Built-in Async – Boost performance with CompletableFuture.
✅ Stream-Friendly – Sync & async line streaming.
✅ Charset Control – Easily switch encodings.
✅ Lightweight – Minimal dependencies, fast and focused.

---

🚀 Features

• 📄 Read text files into memory (StringBuilder)
• 🤖 Automatically chooses efficient read strategy (Buffered, NIO, Mapped)
• ⏱️ Read files asynchronously
• 📥 Line-by-line streaming (sync & async)
• 🌍 Support for multiple charsets (UTF-8, ISO-8859-1, UTF-16 etc.)
• 🧪 Simple API ideal for logging, parsing, and file analysis

---

📦 Installation

Maven

<dependency>
  <groupId>io.github.raghul-tech</groupId>
  <artifactId>openloom</artifactId>
  <version>0.0.2</version>
</dependency>

Gradle

implementation 'io.github.raghul-tech:openloom:0.0.2'

---

✍️ Usage Examples

🔹 Basic File Read

➡️ BasicReadExample.java

OpenLoom reader = new OpenLoom();
StringBuilder content = reader.read(new File("example.txt"));
System.out.println(content);

🔹 Read using Path

➡️ PathReadExample.java

StringBuilder content = reader.read(Paths.get("data/example.txt"));

🔹 Async Read

➡️ AsyncReadExample.java

reader.readAsync(new File("large.txt")).thenAccept(content -> {
    System.out.println("First 100 chars: " + content.substring(0, 100));
});

🔹 Stream Lines (Sync & Async)

➡️ StreamLineExample.java

reader.streamLines(new File("log.txt"), System.out::println);
reader.streamLinesAsync(Paths.get("errors.log"), line -> {
    if (line.contains("ERROR")) System.err.println("Error line: " + line);
});

🔹 Change Charset (Mid-execution)

➡️ CharsetExample.java

OpenLoom reader = new OpenLoom(StandardCharsets.ISO_8859_1);
StringBuilder content = reader.read(Paths.get("legacy.txt"));
reader.setCharset(StandardCharsets.UTF_16);

---

💡 Run Using JAR

🧵 Compile:

javac -cp openloom-0.0.2.jar ReadExampleWithFile.java

▶️ Run:

Windows:

java -cp .;openloom-0.0.2.jar ReadExampleWithFile   

Linux/macOS:

java -cp .:openloom-0.0.2.jar ReadExampleWithFile   

---

🧩 Requirements

• Java 8 or above (JDK 17+ recommended)

---

📂 Example Files

✅ Ready-to-run examples in the examples/ folder:

• ReadExampleWithFile.java

• ReadExampleWithPath.java

• ReadAsyncExampleWithFile.java

• ReadAsyncExampleWithPath.java

• StreamLinesExampleWithFile.java

• StreamLinesExampleWithPath.java

• StreamLinesAsyncExampleWithFile.java

• StreamLinesAsyncExampleWithPath.java

• CharsetExample.java

---

🆕 Changelog:

• View all releases on the Releases Page.

• For a detailed log of all changes, refer to the CHANGELOG.md file.

---

🤝 Contributing

• We welcome PRs for:

  • 🐛 Bug fixes

  • 🚀 New features

  • 🧪 More examples

  • 📝 Documentation

Read the Contributing Guide before starting..

---

🐞 Report a Bug

• If you've encountered a bug, please report it by clicking the link below. This will guide you through the bug-reporting process: ➡️ Click here to report a bug

---

📄 License

• This project is licensed under the Apache License 2.0.

---

📬 Contact

Email: raghultech.app@gmail.com

---

☕ Support

If OpenLoom helped you, you can support it here ❤️