Clean up and add missing docs

Author: Mitja Leino

src/main/java/com/redhat/devtools/lsp4ij/launching/ui/NewLanguageServerDialog.java

@@ -7,6 +7,7 @@
  *
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
+ * Mitja Leino <[email protected]> - Extend ValidatableDialog for validations
  ******************************************************************************/
 package com.redhat.devtools.lsp4ij.launching.ui;
 

src/main/java/com/redhat/devtools/lsp4ij/settings/LanguageServerView.java

@@ -10,7 +10,7 @@
  *
  * Contributors:
  *     Red Hat Inc. - initial API and implementation
- *     Mitja Leino <[email protected]> - Implement DialogWrapper for validations
+ *     Mitja Leino <[email protected]> - Extend ValidatableDialog for validations
  *******************************************************************************/
 package com.redhat.devtools.lsp4ij.settings;
 
@@ -20,7 +20,6 @@
 import com.intellij.openapi.fileTypes.FileNameMatcher;
 import com.intellij.openapi.fileTypes.FileType;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.ui.DialogWrapper;
 import com.intellij.openapi.ui.ValidationInfo;
 import com.intellij.ui.IdeBorderFactory;
 import com.intellij.util.ui.FormBuilder;

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/CommandLineWidget.java

@@ -20,6 +20,7 @@
 import com.redhat.devtools.lsp4ij.LanguageServerBundle;
 
 import javax.swing.border.Border;
+import java.util.ArrayList;
 import java.util.List;
 
 /**
@@ -41,14 +42,17 @@ public CommandLineWidget() {
 
     @Override
     public void validate(List<ValidationInfo> validations) {
-        boolean valid = true;
+        List<ValidationInfo> widgetValidations = new ArrayList<>();
+
         if (getDocument() != null && getText().isBlank()) {
-            setErrorBorder(this);
-            valid = false;
-            validations.add(new ValidationInfo(errorMessage, this));
+            widgetValidations.add(new ValidationInfo(errorMessage, this));
         }
-        if (valid) {
+
+        if (widgetValidations.isEmpty()) {
             this.setBorder(normalBorder);
+        } else {
+            validations.addAll(widgetValidations);
+            setErrorBorder(this);
         }
     }
 }

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/LanguageServerPanel.java

@@ -7,6 +7,7 @@
  *
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
+ * Mitja Leino <[email protected]> - Add DialogWrapper for validations
  ******************************************************************************/
 package com.redhat.devtools.lsp4ij.settings.ui;
 
@@ -86,11 +87,14 @@ private void createUI(FormBuilder builder, JComponent description, EditionMode m
         addDebugTab(tabbedPane, mode);
 
         // Add validation
-        var serverName = getServerName();
-        if (serverName != null) {
-            addValidator(serverName);
+        var serverNameWidget = getServerName();
+        if (serverNameWidget != null) {
+            addValidator(serverNameWidget);
+        }
+        var commandLineWidget = getCommandLine();
+        if (commandLineWidget != null) {
+            addValidator(getCommandLine());
         }
-        addValidator(getCommandLine());
     }
 
     private void addServerTab(JBTabbedPane tabbedPane, JComponent description, EditionMode mode) {

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/ServerNameWidget.java

@@ -16,6 +16,7 @@
 import com.redhat.devtools.lsp4ij.LanguageServerBundle;
 
 import javax.swing.border.Border;
+import java.util.ArrayList;
 import java.util.List;
 
 /**
@@ -31,14 +32,17 @@ public ServerNameWidget() {
 
     @Override
     public void validate(List<ValidationInfo> validations) {
-        boolean isValid = true;
+        List<ValidationInfo> widgetValidations = new ArrayList<>();
+
         if (getDocument() != null && getText().isBlank()) {
-            setErrorBorder(this);
-            isValid = false;
-            validations.add(new ValidationInfo(errorMessage, this));
+            widgetValidations.add(new ValidationInfo(errorMessage, this));
         }
-        if (isValid) {
+
+        if (widgetValidations.isEmpty()) {
             this.setBorder(originalBorder);
+        } else {
+            validations.addAll(widgetValidations);
+            setErrorBorder(this);
         }
     }
 

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/ValidatableConsoleWidget.java

@@ -34,5 +34,10 @@ default void setErrorBorder(JComponent jComponent) {
         jComponent.setBorder(JBUI.Borders.customLine(color, 1));
     }
 
+    /**
+     * Runs validations on the widget and handles border styling
+     * @param validations the dialog wrapper validation list,
+     *                    adds the validations to the list if there are any errors
+     */
     void validate(List<ValidationInfo> validations);
 }

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/ValidatableDialog.java

@@ -1,10 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Red Hat Inc. and others.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Mitja Leino <[email protected]> - Initial API and implementation
+ *******************************************************************************/
 package com.redhat.devtools.lsp4ij.settings.ui;
 
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.ui.DialogWrapper;
 
+/**
+ * Shareable component for shared validations using DialogWrapper
+ */
 public abstract class ValidatableDialog extends DialogWrapper {
-    public ValidatableDialog(Project project) {
+    protected ValidatableDialog(Project project) {
         super(project);
     }