From dccbed87a71bceb30a4271d15c2f95d34d87cdec Mon Sep 17 00:00:00 2001
From: Darin Kelkhoff <darin.kelkhoff@gmail.com>
Date: Mon, 15 Jan 2024 20:21:48 -0600
Subject: [PATCH] CE-781 Add javadoc

---
 .../metadata/FilesystemTableMetaDataBuilder.java      | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/qqq-backend-module-filesystem/src/main/java/com/kingsrook/qqq/backend/module/filesystem/base/model/metadata/FilesystemTableMetaDataBuilder.java b/qqq-backend-module-filesystem/src/main/java/com/kingsrook/qqq/backend/module/filesystem/base/model/metadata/FilesystemTableMetaDataBuilder.java
index 18b588e6..b98d30f7 100644
--- a/qqq-backend-module-filesystem/src/main/java/com/kingsrook/qqq/backend/module/filesystem/base/model/metadata/FilesystemTableMetaDataBuilder.java
+++ b/qqq-backend-module-filesystem/src/main/java/com/kingsrook/qqq/backend/module/filesystem/base/model/metadata/FilesystemTableMetaDataBuilder.java
@@ -33,7 +33,18 @@ import com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata.S3TableBack
 
 
 /*******************************************************************************
+ ** Builder class to create standard style QTableMetaData for tables in filesystem
+ ** modules (avoid some boilerplate).
  **
+ ** e.g., lets us create a file-based table like so:
+ <pre>
+ QTableMetaData table = new FilesystemTableMetaDataBuilder()
+ .withName("myTableName")
+ .withBackend(qInstance.getBackend("myBackendName"))
+ .withGlob("*.csv")
+ .withBasePath("/")
+ .buildStandardCardinalityOneTable();
+ </pre>
  *******************************************************************************/
 public class FilesystemTableMetaDataBuilder
 {