Add more documentation

Author: Fernthedev

core/src/main/java/com/github/fernthedev/fernapi/universal/data/database/RowData.java

@@ -30,13 +30,21 @@ public abstract class RowData {
     private final Map<Field, ColumnData> cachedData = new LinkedHashMap<>();
     private final Map<String, ColumnData> cachedDataStr = new LinkedHashMap<>();
 
+    /**
+     * Use to instantiate Row Data with empty data.
+     *
+     * It is recommended to call {@link #initiateRowData()} after your values are instantiated.
+     */
     public RowData() {
         validateKeys(getClass());
         instance = this;
     }
 
     /**
-     * Must set initiated to true to avoid problems when overriden.
+     * Must set initiated to true to avoid problems when overridden.
+     *
+     * Called when retrieving the data from the SQL table.
+     *
      * @param rowData
      */
     @OverridingMethodsMustInvokeSuper
@@ -61,6 +69,12 @@ protected void initiateRowData(DbRow rowData) {
         }
     }
 
+    /**
+     * Must set initiated to true to avoid problems when overridden.
+     *
+     * Called when setting the data of the class manually.
+     *
+     */
     protected void initiateRowData() {
         if (initiated)
             throw new IllegalStateException("Already initiated row data and is immutable.");
@@ -80,6 +94,11 @@ protected void initiateRowData() {
         }
     }
 
+    /**
+     * Validates that the row data fields are properly configured.
+     * @param rowData
+     * @param <T>
+     */
     public static <T> void validateKeys(Class<T> rowData) {
 
         boolean anyColumns = Arrays.stream(rowData.getDeclaredFields()).anyMatch(field -> field.isAnnotationPresent(Column.class));
@@ -121,13 +140,25 @@ private void addField(Field field, ColumnData columnData, Object value) {
     }
 
 
+    /**
+     * Retrieves the column data
+     *
+     * @param sqlName The name of the column in the SQL table
+     * @return The column data
+     */
     public ColumnData getColumn(String sqlName) {
         if (!initiated)
             initiateRowData();
 
         return cachedDataStr.get(sqlName);
     }
 
+    /**
+     * Retrieves the column data
+     *
+     * @param field The field referencing the SQL data.
+     * @return The column data
+     */
     public ColumnData getColumn(Field field) {
         if (!initiated)
             initiateRowData();

core/src/main/java/com/github/fernthedev/fernapi/universal/data/database/RowDataTemplate.java

@@ -9,6 +9,13 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+/**
+ * Creates a basic and empty version of the
+ * RowData class to reference when creating
+ * or parsing a row from a table.
+ *
+ * @param <T>
+ */
 public class RowDataTemplate<T extends RowData> {
 
     private final Map<Field, ColumnData> cachedData = new LinkedHashMap<>();
@@ -49,6 +56,11 @@ private void addField(Field field, ColumnData columnData) {
         cachedDataStr.put(field.getAnnotation(Column.class).value(), columnData);
     }
 
+    /**
+     * The SQL column name of the primary key
+     *
+     * @return
+     */
     public String getPrimaryKeySQL() {
         return primaryKeyField.getAnnotation(Column.class).value();
     }

core/src/main/java/com/github/fernthedev/fernapi/universal/data/database/TableInfo.java

@@ -28,6 +28,15 @@ public class TableInfo<T extends RowData> {
     @Getter
     private final RowDataTemplate<T> rowDataTemplate;
 
+    /**
+     *
+     * @param tableName The name of the table
+     * @param rowClass The class of the Row Data
+     * @param rowSupplier The supplier should return a new and empty instance of the Row Class.
+     *                    This instance should not call {@link RowData#initiateRowData()}
+     *                    when constructed. Reflection will be used to
+     *                    set the field values accordingly.
+     */
     public TableInfo(String tableName, @NonNull Class<T> rowClass, Supplier<@NonNull T> rowSupplier) {
         this.tableName = tableName;
         this.rowClass = rowClass;
@@ -51,6 +60,12 @@ public CompletableFuture<TableInfo<T>> loadFromDB(DatabaseListener databaseListe
         });
     }
 
+    /**
+     * Internal usage. Sets the rows
+     *
+     * @param dbRowList
+     */
+    @Deprecated
     public void setRows(List<DbRow> dbRowList) {
         rowDataList.clear();
         dbRowList.forEach(this::addRow);
@@ -69,7 +84,12 @@ private void addRow(DbRow dbRow) {
     }
 
 
-
+    /**
+     * Retrieves the row based on the primary key.
+     *
+     * @param key The value of the key
+     * @return The row
+     */
     public T getRow(String key) {
         return rowDataList.get(key);
     }