Simplify and unify validations

Author: Mitja Leino

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

@@ -420,9 +420,8 @@ public void setInitializationOptionsContent(String initializationOptionsContent)
     }
 
     @Override
-    protected @Nullable ValidationInfo doValidate() {
-        // Server name is not editable for existing language servers
-        return this.languageServerPanel.getCommandLine().getValidationInfo();
+    public @NotNull List<ValidationInfo> doValidateAll() {
+        return languageServerPanel.doValidateAll();
     }
 
     @Override

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.List;
 
 /**
  * Command line widget used to fill the command to start a language
@@ -36,28 +37,18 @@ public CommandLineWidget() {
         super.setFont(JBFont.regular());
         super.getEmptyText().setText(LanguageServerBundle.message("language.server.command.emptyText"));
         this.normalBorder = this.getBorder();
-        addListeners(this);
     }
 
     @Override
-    public void validateInput() {
-        if (isValid()) {
-            this.setBorder(normalBorder);
-        } else {
+    public void validate(List<ValidationInfo> validations) {
+        boolean valid = true;
+        if (getDocument() != null && getText().isBlank()) {
             setErrorBorder(this);
+            valid = false;
+            validations.add(new ValidationInfo(errorMessage, this));
         }
-    }
-
-    @Override
-    public ValidationInfo getValidationInfo() {
-        if (isValid()) {
-            return null;
+        if (valid) {
+            this.setBorder(normalBorder);
         }
-        return new ValidationInfo(errorMessage, this);
-    }
-
-    @Override
-    public boolean isValid() {
-        return getDocument() != null && !getText().isBlank();
     }
 }

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

@@ -254,25 +254,17 @@ public ComboBox<ErrorReportingKind> getErrorReportingKindCombo() {
 
     public @NotNull List<ValidationInfo> doValidateAll() {
         List<ValidationInfo> validations = new ArrayList<>();
-        var serverName = getServerName();
-        if (serverName != null) {
-            addValidationInfo(serverName.getValidationInfo(), validations);
+        var serverNameWidget = getServerName();
+        if (serverNameWidget != null) {
+            serverNameWidget.validate(validations);
         }
-        var commandLine = getCommandLine();
-        if (commandLine != null) {
-            addValidationInfo(commandLine.getValidationInfo(), validations);
+        var commandLineWidget = getCommandLine();
+        if (commandLineWidget != null) {
+            commandLineWidget.validate(validations);
         }
         return validations;
     }
 
-    private void addValidationInfo(ValidationInfo validationInfo, List<ValidationInfo> validations) {
-        if (validationInfo == null) {
-            return;
-        }
-        validations.add((validationInfo));
-    }
-
-
     private void addValidator(JTextComponent textComponent) {
         textComponent.getDocument().addDocumentListener(new DocumentAdapter() {
             @Override

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.List;
 
 /**
  * Server name widget that contains the server name when creating a new LS configuration
@@ -26,24 +27,19 @@ public class ServerNameWidget extends JBTextField implements ValidatableConsoleW
 
     public ServerNameWidget() {
         this.originalBorder = this.getBorder();
-        addListeners(this);
     }
 
     @Override
-    public void validateInput() {
-        if (isValid()) {
-            this.setBorder(originalBorder);
-        } else {
+    public void validate(List<ValidationInfo> validations) {
+        boolean isValid = true;
+        if (getDocument() != null && getText().isBlank()) {
             setErrorBorder(this);
+            isValid = false;
+            validations.add(new ValidationInfo(errorMessage, this));
         }
-    }
-
-    @Override
-    public ValidationInfo getValidationInfo() {
-        if (isValid()) {
-            return null;
+        if (isValid) {
+            this.setBorder(originalBorder);
         }
-        return new ValidationInfo(errorMessage, this);
     }
 
     @Override

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

@@ -12,18 +12,12 @@
 package com.redhat.devtools.lsp4ij.settings.ui;
 
 import com.intellij.openapi.ui.ValidationInfo;
-import com.intellij.ui.DocumentAdapter;
 import com.intellij.ui.JBColor;
-import com.intellij.ui.components.JBTextArea;
-import com.intellij.ui.components.JBTextField;
 import com.intellij.util.ui.JBUI;
-import org.jetbrains.annotations.NotNull;
 
 import javax.swing.*;
-import javax.swing.event.DocumentEvent;
+import java.util.List;
 import java.awt.*;
-import java.awt.event.FocusAdapter;
-import java.awt.event.FocusEvent;
 
 /**
  * A shared interface meant to simplify creating validatable components used in
@@ -40,47 +34,5 @@ default void setErrorBorder(JComponent jComponent) {
         jComponent.setBorder(JBUI.Borders.customLine(color, 1));
     }
 
-    /**
-     * Add listeners that handle input validation. The first instance of validation should run on focus
-     * and then on each change
-     * @param jComponent interface implementor (e.g. addListeners(this);)
-     */
-    default void addListeners(JComponent jComponent) {
-        jComponent.addFocusListener(new FocusAdapter() {
-            @Override
-            public void focusGained(FocusEvent e) {
-                validateInput();
-                super.focusGained(e);
-            }
-        });
-
-        DocumentAdapter adapter = new DocumentAdapter() {
-            @Override
-            protected void textChanged(@NotNull DocumentEvent e) {
-                validateInput();
-            }
-        };
-        if (jComponent instanceof JBTextField jbTextField) {
-            jbTextField.getDocument().addDocumentListener(adapter);
-        } else if (jComponent instanceof JBTextArea jbTextArea) {
-            jbTextArea.getDocument().addDocumentListener(adapter);
-        }
-    }
-
-    /**
-     * Overridable method that implements the field validation
-     * Handles updating the style of the component for error/valid
-     */
-    void validateInput();
-
-    /**
-     * Overridable method that returns a ValidationInfo, is the component is not valid
-     * @return a ValidationInfo element if component validation fails, null if component is valid
-     */
-    ValidationInfo getValidationInfo();
-
-    /**
-     * Overridable method that has to implement the validation check
-     */
-    boolean isValid();
+    void validate(List<ValidationInfo> validations);
 }