Add javadocs

src/main/java/formflow/library/ValidationService.java

@@ -46,6 +46,8 @@ public class ValidationService {
    * Autoconfigured constructor.
    *
    * @param validator Validator from Jakarta package.
+   * @param actionManager the <code>ActionManager</code> that manages the logic to be run at specific points
+   * @param inputConfigPath the package path where inputs classes are located
    */
   public ValidationService(Validator validator, ActionManager actionManager,
       @Value("${form-flow.inputs: 'formflow.library.inputs.'}") String inputConfigPath) {
@@ -60,6 +62,7 @@ public ValidationService(Validator validator, ActionManager actionManager,
    * @param currentScreen  The screen we are currently validating form data from
    * @param flowName       The name of the current flow, not null
    * @param formSubmission The input data from a form as a map of field name to field value(s), not null
+   * @param submission     The submission that we are cross validating with
    * @return a HashMap of field to list of error messages, will be empty if no field violations
    */
   public Map<String, List<String>> validate(ScreenNavigationConfiguration currentScreen, String flowName,

src/main/java/formflow/library/data/Submission.java

@@ -76,6 +76,9 @@ public class Submission {
   @Column(name = "submitted_at")
   private Date submittedAt;
 
+  /**
+   * Creates a new <code>Submission</code> with empty content
+   */
   public Submission() {
     inputData = new HashMap<>();
     urlParams = new HashMap<>();
@@ -120,8 +123,13 @@ public void mergeFormDataWithSubmissionData(FormSubmission formSubmission) {
     inputData = formSubmission.getFormData();
   }
 
-  public void mergeUrlParamsWithData(Map<String, String> passedParams) {
-    urlParams.putAll(passedParams);
+  /**
+   * Merges the passed in query parameters into the Submission's urlParams Map
+   *
+   * @param queryParams the Map of query parameters to merge in
+   */
+  public void mergeUrlParamsWithData(Map<String, String> queryParams) {
+    urlParams.putAll(queryParams);
   }
 
   /**

src/main/java/formflow/library/data/SubmissionEncryptionService.java

@@ -19,9 +19,16 @@
 import org.springframework.stereotype.Service;
 import org.springframework.util.StringUtils;
 
+/**
+ * Service providing encryption and decryption of designated fields in a <code>Submission</code> using Google's
+ * Tink Cryptographic Library
+ */
 @Service
 public class SubmissionEncryptionService {
 
+  /**
+   * Suffix added to the field name for encrypted fields
+   */
   public final String ENCRYPT_SUFFIX = "_encrypted";
   private final Aead encDec;
   private final String inputConfigPath;
@@ -31,6 +38,11 @@ private enum EncryptionDirection {
     DECRYPT
   }
 
+  /**
+   * Constructs an instance of the <code>SubmissionEncryptionService</code>
+   * @param key the key used to encrypt the fields
+   * @param inputConfigPath the package path where inputs classes are located
+   */
   public SubmissionEncryptionService(
       @Value("${form-flow.encryption-key:#{null}}") String key,
       @Value("${form-flow.inputs: 'formflow.library.inputs.'}") String inputConfigPath) {

src/main/java/formflow/library/data/UserFileRepository.java

@@ -6,7 +6,7 @@
 import org.springframework.stereotype.Repository;
 
 /**
- * Repository interface for the SubmissionRepository.
+ * Repository interface for UserFile objects
  */
 @Repository
 public interface UserFileRepository extends JpaRepository<UserFile, UUID> {