IMessageCheck now returns an IMessageCheckResult instead of a boolean

eclipse-babel · Oct 23, 2023 · 86b5280 · 86b5280
1 parent 049775e
commit 86b5280
Show file tree

Hide file tree

Showing 15 changed files with 165 additions and 80 deletions.
diff --git a/org.eclipse.babel.core/src/org/eclipse/babel/core/message/checks/IMessageCheck.java b/org.eclipse.babel.core/src/org/eclipse/babel/core/message/checks/IMessageCheck.java
@@ -31,7 +31,8 @@ public interface IMessageCheck {
      *            messages bundle group
      * @param message
      *            the message being tested
-     * @return <code>true</code> if condition is successfully tested
+     * @return <code>MessageCheckResult.OK</code> if condition is successfully tested
      */
-    boolean checkKey(IMessagesBundleGroup messagesBundleGroup, IMessage message);
+	IMessageCheckResult checkKey(IMessagesBundleGroup messagesBundleGroup, IMessage message);
+
 }
diff --git a/org.eclipse.babel.core/src/org/eclipse/babel/core/message/checks/IMessageCheckResult.java b/org.eclipse.babel.core/src/org/eclipse/babel/core/message/checks/IMessageCheckResult.java
@@ -0,0 +1,6 @@
+package org.eclipse.babel.core.message.checks;
+
+public interface IMessageCheckResult {
+	String getText();
+	IMessageCheck getMessageCheck();
+}
diff --git a/org.eclipse.babel.core/src/org/eclipse/babel/core/message/checks/MessageCheckResult.java b/org.eclipse.babel.core/src/org/eclipse/babel/core/message/checks/MessageCheckResult.java
@@ -0,0 +1,25 @@
+package org.eclipse.babel.core.message.checks;
+
+public class MessageCheckResult implements IMessageCheckResult {
+
+	public static final IMessageCheckResult OK = new MessageCheckResult("", null);//$NON-NLS-1$
+
+	private String text;
+	private IMessageCheck messageCheck;
+
+	public MessageCheckResult(String text, IMessageCheck messageCheck) {
+		this.text = text;
+		this.messageCheck = messageCheck;
+	}
+
+	@Override
+	public String getText() {
+		return this.text;
+	}
+
+	@Override
+	public IMessageCheck getMessageCheck() {
+		return this.messageCheck;
+	}
+
+}
diff --git a/...se.babel.core/src/org/eclipse/babel/core/message/checks/internal/DuplicateValueCheck.java b/...se.babel.core/src/org/eclipse/babel/core/message/checks/internal/DuplicateValueCheck.java
@@ -17,6 +17,8 @@
 import org.eclipse.babel.core.message.IMessagesBundle;
 import org.eclipse.babel.core.message.IMessagesBundleGroup;
 import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.IMessageCheckResult;
+import org.eclipse.babel.core.message.checks.MessageCheckResult;
 import org.eclipse.babel.core.util.BabelUtils;
 
 /**
@@ -26,25 +28,18 @@
  */
 public class DuplicateValueCheck implements IMessageCheck {
 
-    private String[] duplicateKeys;
+	public static final DuplicateValueCheck INSTANCE = new DuplicateValueCheck();
 
     /**
      * Constructor.
      */
-    public DuplicateValueCheck() {
+    private DuplicateValueCheck() {
         super();
     }
 
-    /**
-     * Resets the collected keys to null.
-     */
-    public void reset() {
-        duplicateKeys = null;
-    }
-
-    public boolean checkKey(IMessagesBundleGroup messagesBundleGroup,
+    public IMessageCheckResult checkKey(IMessagesBundleGroup messagesBundleGroup,
             IMessage message) {
-        Collection<String> keys = new ArrayList<String>();
+        Collection<String> keys = new ArrayList<>();
         if (message != null) {
             IMessagesBundle messagesBundle = messagesBundleGroup
                     .getMessagesBundle(message.getLocale());
@@ -60,12 +55,10 @@ public boolean checkKey(IMessagesBundleGroup messagesBundleGroup,
             }
         }
 
-        duplicateKeys = keys.toArray(new String[] {});
-        return !keys.isEmpty();
-    }
-
-    public String[] getDuplicateKeys() {
-        return duplicateKeys;
+        if ( keys.isEmpty() ) {
+        	return MessageCheckResult.OK;
+        } else {
+        	return new DuplicateValueMessageCheckResult(keys.toArray(String[]::new), this);
+        }
     }
-
 }
diff --git a/.../src/org/eclipse/babel/core/message/checks/internal/DuplicateValueMessageCheckResult.java b/.../src/org/eclipse/babel/core/message/checks/internal/DuplicateValueMessageCheckResult.java
@@ -0,0 +1,19 @@
+package org.eclipse.babel.core.message.checks.internal;
+
+import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.MessageCheckResult;
+
+public class DuplicateValueMessageCheckResult extends MessageCheckResult {
+
+	private String[] duplicateKeys;
+
+	public DuplicateValueMessageCheckResult(String[] duplicateKeys, IMessageCheck messageCheck) {
+		super("", messageCheck);
+		this.duplicateKeys = duplicateKeys;
+	}
+
+	public String[] getDuplicateKeys() {
+		return this.duplicateKeys;
+	}
+
+}
diff --git a/...ipse.babel.core/src/org/eclipse/babel/core/message/checks/internal/MissingValueCheck.java b/...ipse.babel.core/src/org/eclipse/babel/core/message/checks/internal/MissingValueCheck.java
@@ -13,6 +13,8 @@
 import org.eclipse.babel.core.message.IMessage;
 import org.eclipse.babel.core.message.IMessagesBundleGroup;
 import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.IMessageCheckResult;
+import org.eclipse.babel.core.message.checks.MessageCheckResult;
 
 /**
  * Visitor for finding if a key has at least one corresponding bundle entry with
@@ -23,7 +25,7 @@
 public class MissingValueCheck implements IMessageCheck {
 
     /** The singleton */
-    public static MissingValueCheck MISSING_KEY = new MissingValueCheck();
+    public static final MissingValueCheck INSTANCE = new MissingValueCheck();
 
     /**
      * Constructor.
@@ -36,12 +38,13 @@ private MissingValueCheck() {
      * @see org.eclipse.babel.core.message.internal.checks.IMessageCheck#checkKey(org.eclipse.babel.core.message.internal.MessagesBundleGroup,
      *      org.eclipse.babel.core.message.internal.Message)
      */
-    public boolean checkKey(IMessagesBundleGroup messagesBundleGroup,
+    public IMessageCheckResult checkKey(IMessagesBundleGroup messagesBundleGroup,
             IMessage message) {
         if (message == null || message.getValue() == null
                 || message.getValue().length() == 0) {
-            return true;
+            return MessageCheckResult.OK;
         }
-        return false;
+        return new MissingValueCheckResult(this);
     }
+
 }
diff --git a/...abel.core/src/org/eclipse/babel/core/message/checks/internal/MissingValueCheckResult.java b/...abel.core/src/org/eclipse/babel/core/message/checks/internal/MissingValueCheckResult.java
@@ -0,0 +1,12 @@
+package org.eclipse.babel.core.message.checks.internal;
+
+import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.MessageCheckResult;
+
+public class MissingValueCheckResult extends MessageCheckResult {
+
+	public MissingValueCheckResult(IMessageCheck messageCheck) {
+		super("", messageCheck);
+	}
+
+}
diff --git a/...ipse.babel.core/src/org/eclipse/babel/core/message/checks/internal/SimilarValueCheck.java b/...ipse.babel.core/src/org/eclipse/babel/core/message/checks/internal/SimilarValueCheck.java
@@ -17,7 +17,10 @@
 import org.eclipse.babel.core.message.IMessagesBundle;
 import org.eclipse.babel.core.message.IMessagesBundleGroup;
 import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.IMessageCheckResult;
+import org.eclipse.babel.core.message.checks.MessageCheckResult;
 import org.eclipse.babel.core.message.checks.proximity.IProximityAnalyzer;
+import org.eclipse.babel.core.message.checks.proximity.LevenshteinDistanceAnalyzer;
 import org.eclipse.babel.core.util.BabelUtils;
 
 /**
@@ -30,10 +33,13 @@ public class SimilarValueCheck implements IMessageCheck {
     private String[] similarKeys;
     private IProximityAnalyzer analyzer;
 
+    /** The singleton */
+    public static final SimilarValueCheck INSTANCE = new SimilarValueCheck(LevenshteinDistanceAnalyzer.getInstance());
+
     /**
      * Constructor.
      */
-    public SimilarValueCheck(IProximityAnalyzer analyzer) {
+    private SimilarValueCheck(IProximityAnalyzer analyzer) {
         super();
         this.analyzer = analyzer;
     }
@@ -42,7 +48,7 @@ public SimilarValueCheck(IProximityAnalyzer analyzer) {
      * @see org.eclipse.babel.core.message.internal.checks.IMessageCheck#checkKey(org.eclipse.babel.core.message.internal.MessagesBundleGroup,
      *      org.eclipse.babel.core.message.internal.Message)
      */
-    public boolean checkKey(IMessagesBundleGroup messagesBundleGroup,
+    public IMessageCheckResult checkKey(IMessagesBundleGroup messagesBundleGroup,
             IMessage message) {
         Collection<String> keys = new ArrayList<String>();
         if (message != null) {
@@ -67,16 +73,11 @@ public boolean checkKey(IMessagesBundleGroup messagesBundleGroup,
                 keys.add(message.getKey());
             }
         }
-        similarKeys = keys.toArray(new String[] {});
-        return !keys.isEmpty();
-    }
 
-    /**
-     * Gets similar keys.
-     * 
-     * @return similar keys
-     */
-    public String[] getSimilarMessageKeys() {
-        return similarKeys;
+        if ( !keys.isEmpty() ) {
+        	return MessageCheckResult.OK;
+        } else {
+        	return new SimilarValueMessageCheckResult(keys.toArray(String[]::new), this);
+        }
     }
 }
diff --git a/...re/src/org/eclipse/babel/core/message/checks/internal/SimilarValueMessageCheckResult.java b/...re/src/org/eclipse/babel/core/message/checks/internal/SimilarValueMessageCheckResult.java
@@ -0,0 +1,19 @@
+package org.eclipse.babel.core.message.checks.internal;
+
+import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.MessageCheckResult;
+
+public class SimilarValueMessageCheckResult extends MessageCheckResult {
+
+	private String[] similarValueKeys;
+
+	public SimilarValueMessageCheckResult(String[] similarValueKeys, IMessageCheck messageCheck) {
+		super("", messageCheck);
+		this.similarValueKeys = similarValueKeys;
+	}
+
+	public String[] getSimilarMessageKeys() {
+		return similarValueKeys;
+	}
+
+}
diff --git a/org.eclipse.babel.editor/src/org/eclipse/babel/editor/i18n/EntryRightBanner.java b/org.eclipse.babel.editor/src/org/eclipse/babel/editor/i18n/EntryRightBanner.java
@@ -18,8 +18,11 @@
 import java.util.Observer;
 
 import org.eclipse.babel.core.message.checks.IMessageCheck;
+import org.eclipse.babel.core.message.checks.IMessageCheckResult;
 import org.eclipse.babel.core.message.checks.internal.DuplicateValueCheck;
+import org.eclipse.babel.core.message.checks.internal.DuplicateValueMessageCheckResult;
 import org.eclipse.babel.core.message.checks.internal.MissingValueCheck;
+import org.eclipse.babel.core.message.checks.internal.MissingValueCheckResult;
 import org.eclipse.babel.editor.IMessagesEditorChangeListener;
 import org.eclipse.babel.editor.i18n.actions.ShowDuplicateAction;
 import org.eclipse.babel.editor.i18n.actions.ShowMissingAction;
@@ -116,10 +119,10 @@ public void run() {
                 toolBarMgr.removeAll();
                 actionByMarkerIds.clear();
                 String key = editor.getSelectedKey();
-                Collection<IMessageCheck> checks = editor.getMarkers()
+                Collection<IMessageCheckResult> checks = editor.getMarkers()
                         .getFailedChecks(key, locale);
                 if (checks != null) {
-                    for (IMessageCheck check : checks) {
+                    for (IMessageCheckResult check : checks) {
                         Action action = getCheckAction(key, check);
                         if (action != null) {
                             toolBarMgr.add(action);
@@ -141,12 +144,12 @@ public void run() {
 
     }
 
-    private Action getCheckAction(String key, IMessageCheck check) {
-        if (check instanceof MissingValueCheck) {
+    private Action getCheckAction(String key, IMessageCheckResult check) {
+        if (check instanceof MissingValueCheckResult checkResult) {
             return new ShowMissingAction(key, locale);
-        } else if (check instanceof DuplicateValueCheck) {
+        } else if (check instanceof DuplicateValueMessageCheckResult checkResult) {
             return new ShowDuplicateAction(
-                    ((DuplicateValueCheck) check).getDuplicateKeys(), key,
+            		checkResult.getDuplicateKeys(), key,
                     locale);
         }
         return null;