From 309a337698428e7518f2587486e59df88c47a92f Mon Sep 17 00:00:00 2001
From: NONPLAYT <76615486+NONPLAYT@users.noreply.github.com>
Date: Sun, 13 Jul 2025 18:02:02 +0300
Subject: [PATCH] add jd for buffered

---
 .../divinemc/region/type/BufferedRegionFile.java | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/divinemc-server/src/main/java/org/bxteam/divinemc/region/type/BufferedRegionFile.java b/divinemc-server/src/main/java/org/bxteam/divinemc/region/type/BufferedRegionFile.java
index 5f773dd..45b7b93 100644
--- a/divinemc-server/src/main/java/org/bxteam/divinemc/region/type/BufferedRegionFile.java
+++ b/divinemc-server/src/main/java/org/bxteam/divinemc/region/type/BufferedRegionFile.java
@@ -20,6 +20,22 @@ import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 import java.util.concurrent.atomic.AtomicInteger;
 
+/**
+ * A buffered region file implementation that provides efficient chunk storage and retrieval
+ * with compression, checksums, and automatic compaction capabilities.
+ *
+ * <p>This implementation includes:
+ * <ul>
+ *   <li>Zstandard compression for chunk data</li>
+ *   <li>XXHash32 checksums for data integrity verification</li>
+ *   <li>Automatic file compaction when fragmentation exceeds thresholds</li>
+ *   <li>Thread-safe operations with read-write locks</li>
+ *   <li>Direct ByteBuffer usage for memory efficiency</li>
+ * </ul>
+ *
+ * <p>For conversion tools between MCA and buffered region file formats, see:
+ * <a href="https://github.com/NONPLAYT/LinearRegionFileFormatTools">LinearRegionFileFormatTools</a>
+ */
 public class BufferedRegionFile implements IRegionFile {
     private static final double AUTO_COMPACT_PERCENT = 3.0 / 5.0; // 60%
     private static final long AUTO_COMPACT_SIZE = 1024 * 1024; // 1 MiB