Remove inner classes from UserForm

src/main/asciidoc/developer_documentation.adoc

@@ -175,7 +175,7 @@ image:models/design/clientServer.svg[]
 
 ==== Design Patterns
 * Spring MVC
-* Template Method in `UserForm` (hook method `validatePasswordGeneric`)
+* Template Method in `UserFormWithPassword` (hook method `validatePasswordGeneric`)
 * Template Method in `InventoryMutateForm` (hook method `modifyProductPrimitive`)
 
 ==== Persistence
@@ -293,7 +293,11 @@ image:models/design/user.svg[class design diagram - User]
 |UserManagement |A class that manages the UserRepository.
 |UserRepository |An extension of 'CrudRepository' to store Users.
 |User |A class that allows a person to associate system data with themselves.
-|UserForm |A Form to cache a user input that was made during registration or updating the profile.
+|UserForm |A form to cache a user input that was made during registration or updating the profile.
+|AdminForm |A form to cache the admin input that was made during updating the profile of a customer.
+|UserFormWithPassword |An extension of UserForm with a password attribute.
+|RegistrationForm |A form to cache a user input that was made during registration.
+|ProfileForm |A form to cache a user input that was made during updating the profile.
 |FormValidator |A validator that validates the UserForm.
 |===
 

src/main/asciidoc/models/design/user.puml

@@ -119,22 +119,18 @@ package catering.users {
 	}
 	UserFormWithPassword --> Errors
 	UserFormWithPassword --> ValidationUtils
-	UserFormWithPassword ----+ UserForm
 	UserFormWithPassword --|> UserForm
 	class RegistrationForm extends UserFormWithPassword {
 		+ RegistrationForm(username:String, address:String, fullName:String, password:String)
 		+ {static} empty() : RegistrationForm
 	}
-	RegistrationForm --+ UserFormWithPassword
 	class ProfileForm {
 		+ ProfileForm(username:String, address:String, fullName:String, password:String)
 	}
-	ProfileForm --+ UserFormWithPassword
 	ProfileForm --|> UserFormWithPassword
 	class AdminForm {
 		+ AdminForm(username:String, address:String, fullName:String)
 	}
-	AdminForm --+ UserForm
 	AdminForm --|> UserForm
 	class FormValidator<F extends UserForm> {
 		supports(c:Class<?>) : boolean

src/main/java/catering/users/AdminForm.java

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// SPDX-FileCopyrightText: 2023-2024 swt23w23
+package catering.users;
+
+/**
+ * An extension of {@link UserForm} to validate input during customer profile
+ * editing.
+ */
+public class AdminForm extends UserForm {
+	AdminForm(String username, String address, String fullName) {
+		super(username, address, fullName);
+	}
+}

src/main/java/catering/users/FormValidator.java

@@ -7,8 +7,6 @@ import org.springframework.validation.Errors;
 import org.springframework.validation.ValidationUtils;
 import org.springframework.validation.Validator;
 
-import catering.users.UserForm.UserFormWithPassword;
-
 @Component
 public class FormValidator<F extends UserForm> implements Validator {
 

src/main/java/catering/users/ProfileForm.java

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// SPDX-FileCopyrightText: 2023-2024 swt23w23
+package catering.users;
+
+import org.springframework.validation.Errors;
+
+/**
+ * An extension of {@link UserFormWithPassword} to validate input during profile
+ * editing.
+ *
+ * The password can be empty.
+ */
+public class ProfileForm extends UserFormWithPassword {
+	ProfileForm(String username, String address, String fullName, String password) {
+		super(username, address, fullName, password);
+	}
+
+	public void validatePasswordGeneric(Errors e) {
+		if (e.getFieldValue("password") == null) {
+			e.rejectValue("password", "password must not be null");
+		}
+	}
+}

src/main/java/catering/users/RegistrationForm.java

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// SPDX-FileCopyrightText: 2023-2024 swt23w23
+package catering.users;
+
+import org.springframework.validation.Errors;
+import org.springframework.validation.ValidationUtils;
+
+/**
+ * An extension of {@link UserFormWithPassword} to validate input during
+ * registration.
+ *
+ * It requires the password to be not empty.
+ */
+public class RegistrationForm extends UserFormWithPassword {
+	RegistrationForm(String username, String address, String fullName, String password) {
+		super(username, address, fullName, password);
+	}
+
+	public static RegistrationForm empty() {
+		return new RegistrationForm("", "", "", "");
+	}
+
+	public void validatePasswordGeneric(Errors e) {
+		ValidationUtils.rejectIfEmptyOrWhitespace(e, "password", "password must not be empty");
+	}
+}

src/main/java/catering/users/UserController.java

@@ -2,9 +2,6 @@
 // SPDX-FileCopyrightText: 2023-2024 swt23w23
 package catering.users;
 
-import static catering.users.UserForm.UserFormWithPassword.RegistrationForm;
-import static catering.users.UserForm.UserFormWithPassword.ProfileForm;
-import static catering.users.UserForm.AdminForm;
 import org.springframework.ui.Model;
 import org.salespointframework.useraccount.Role;
 import org.salespointframework.useraccount.UserAccount;

src/main/java/catering/users/UserForm.java

@@ -1,13 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
-// SPDX-FileCopyrightText: 2023 swt23w23
+// SPDX-FileCopyrightText: 2023-2024 swt23w23
 package catering.users;
 
-import org.springframework.validation.ValidationUtils;
-
-import java.util.Optional;
-
-import org.springframework.validation.Errors;
-
 /**
  * An abstract class to hold form input for {@link User} data.
  *
@@ -34,86 +28,4 @@ public abstract class UserForm {
 	public String getFullName() {
 		return fullName;
 	}
-
-	/**
-	 * An extension of {@link UserForm} with a password attribute.
-	 */
-	public abstract static class UserFormWithPassword extends UserForm {
-		private final String password;
-
-		public UserFormWithPassword(String username, String address, String fullName, String password) {
-			super(username, address, fullName);
-			this.password = password;
-		}
-
-		public String getPassword() {
-			return password;
-		}
-
-		/**
-		 * Template Method for validating the password.
-		 *
-		 * @param e {@link Errors} from {@link FormValidator}
-		 */
-		public void validatePassword(Errors e) {
-			validatePasswordGeneric(e);
-			Optional.ofNullable(e.getFieldValue("password")).map(s -> (String) s).ifPresent(s -> {
-				if (s.chars().anyMatch(Character::isISOControl)) {
-					e.rejectValue("password", "password must only contain printable characters");
-				}
-			});
-		}
-
-		/**
-		 * Primitive Operation for validating the password depending on the subclass.
-		 *
-		 * @param e {@link Errors} from {@link FormValidator}
-		 */
-		public abstract void validatePasswordGeneric(Errors e);
-
-		/**
-		 * An extension of {@link UserFormWithPassword} to validate input during registration.
-		 *
-		 * It requires the password to be not empty.
-		 */
-		public static class RegistrationForm extends UserFormWithPassword {
-			RegistrationForm(String username, String address, String fullName, String password) {
-				super(username, address, fullName, password);
-			}
-
-			public static RegistrationForm empty() {
-				return new UserFormWithPassword.RegistrationForm("", "", "", "");
-			}
-
-			public void validatePasswordGeneric(Errors e) {
-				ValidationUtils.rejectIfEmptyOrWhitespace(e, "password", "password must not be empty");
-			}
-		}
-
-		/**
-		 * An extension of {@link UserFormWithPassword} to validate input during profile editing.
-		 *
-		 * The password can be empty.
-		 */
-		public static class ProfileForm extends UserFormWithPassword {
-			ProfileForm(String username, String address, String fullName, String password) {
-				super(username, address, fullName, password);
-			}
-
-			public void validatePasswordGeneric(Errors e) {
-				if (e.getFieldValue("password") == null) {
-					e.rejectValue("password", "password must not be null");
-				}
-			}
-		}
-	}
-
-	/**
-	 * An extension of {@link UserForm} to validate input during customer profile editing.
-	 */
-	public static class AdminForm extends UserForm {
-		AdminForm(String username, String address, String fullName) {
-			super(username, address, fullName);
-		}
-	}
 }

src/main/java/catering/users/UserFormWithPassword.java

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// SPDX-FileCopyrightText: 2023-2024 swt23w23
+package catering.users;
+
+import java.util.Optional;
+
+import org.springframework.validation.Errors;
+
+/**
+ * An extension of {@link UserForm} with a password attribute.
+ */
+public abstract class UserFormWithPassword extends UserForm {
+	private final String password;
+
+	public UserFormWithPassword(String username, String address, String fullName, String password) {
+		super(username, address, fullName);
+		this.password = password;
+	}
+
+	public String getPassword() {
+		return password;
+	}
+
+	/**
+	 * Template Method for validating the password.
+	 *
+	 * @param e {@link Errors} from {@link FormValidator}
+	 */
+	public void validatePassword(Errors e) {
+		validatePasswordGeneric(e);
+		Optional.ofNullable(e.getFieldValue("password")).map(s -> (String) s).ifPresent(s -> {
+			if (s.chars().anyMatch(Character::isISOControl)) {
+				e.rejectValue("password", "password must only contain printable characters");
+			}
+		});
+	}
+
+	/**
+	 * Primitive Operation for validating the password depending on the subclass.
+	 *
+	 * @param e {@link Errors} from {@link FormValidator}
+	 */
+	public abstract void validatePasswordGeneric(Errors e);
+
+}