introduced ConditionedExpressionDescription to avoid String.format()s with positional arguments

Author: Torsten-Mumme

src/main/java/net/itarray/automotion/internal/UIElement.java

@@ -8,6 +8,7 @@
 import net.itarray.automotion.internal.geometry.Scalar;
 import net.itarray.automotion.internal.geometry.Vector;
 import net.itarray.automotion.internal.properties.Context;
+import net.itarray.automotion.internal.properties.SuccessorConditionedExpressionDescription;
 import net.itarray.automotion.tools.general.SystemHelper;
 import net.itarray.automotion.tools.helpers.TextFinder;
 import net.itarray.automotion.validation.properties.Condition;
@@ -336,7 +337,7 @@ public void validateIsAbove(UIElement element, Condition<Scalar> condition, Cont
 
     public void validateSuccessor(Direction direction, UIElement toBeValidatedSuccessor, Condition<Scalar> condition, Context context) {
         Expression<Scalar> signedDistance = Expression.signedDistance(end(direction), toBeValidatedSuccessor.begin(direction), direction);
-        Expression<Boolean> assertion = condition.applyTo(signedDistance, direction.afterName() + " element aligned not properly. Expected margin should be %2$s. Actual margin is %4$s");
+        Expression<Boolean> assertion = condition.applyTo(signedDistance, new SuccessorConditionedExpressionDescription<>(signedDistance, condition, direction));
         if (!assertion.evaluateIn(context, direction)) {
             context.add(assertion.getDescription(context, direction));
             context.draw(toBeValidatedSuccessor);

src/main/java/net/itarray/automotion/internal/properties/ConditionedExpression.java

@@ -1,6 +1,5 @@
 package net.itarray.automotion.internal.properties;
 
-import net.itarray.automotion.internal.geometry.Direction;
 import net.itarray.automotion.internal.geometry.ExtendGiving;
 import net.itarray.automotion.internal.geometry.MetricSpace;
 import net.itarray.automotion.validation.properties.Condition;
@@ -10,16 +9,16 @@ public class ConditionedExpression<T> implements Expression<Boolean> {
 
     private final Expression<T> toBeConditioned;
     private final Condition<T> toBeApplied;
-    private final String messageFormat;
+    private final ConditionedExpressionDescription description;
 
     public ConditionedExpression(Expression<T> toBeConditioned, Condition<T> toBeApplied) {
-        this(toBeConditioned, toBeApplied, "Expected %1$s to be %2$s. Actual %3$s is: %4$s");
+        this(toBeConditioned, toBeApplied, new StandardConditionedExpressionDescription<>(toBeConditioned, toBeApplied));
     }
 
-    public ConditionedExpression(Expression<T> toBeConditioned, Condition<T> toBeApplied, String messageFormat) {
+    public ConditionedExpression(Expression<T> toBeConditioned, Condition<T> toBeApplied, ConditionedExpressionDescription<T> description) {
         this.toBeConditioned = toBeConditioned;
         this.toBeApplied = toBeApplied;
-        this.messageFormat = messageFormat;
+        this.description = description;
     }
 
     @Override
@@ -29,11 +28,7 @@ public <V extends MetricSpace<V>> Boolean evaluateIn(Context context, ExtendGivi
 
     @Override
     public <V extends MetricSpace<V>> String getDescription(Context context, ExtendGiving<V> direction) {
-        T t = toBeConditioned.evaluateIn(context, direction);
-        return String.format(messageFormat,
-                toBeConditioned.getDescription(context, direction),
-                toBeApplied.getDescription(context, direction),
-                toBeConditioned.getRepeatedDescription(context, direction),
-                (t instanceof MetricSpace) ? ((MetricSpace) t).toStringWithUnits("px") : t);
+        return description.describe(context, direction);
     }
+
 }

src/main/java/net/itarray/automotion/internal/properties/ConditionedExpressionDescription.java

@@ -0,0 +1,19 @@
+package net.itarray.automotion.internal.properties;
+
+import net.itarray.automotion.internal.geometry.ExtendGiving;
+import net.itarray.automotion.internal.geometry.MetricSpace;
+import net.itarray.automotion.validation.properties.Condition;
+import net.itarray.automotion.validation.properties.Expression;
+
+public abstract class ConditionedExpressionDescription<T> {
+    protected final Expression<T> toBeConditioned;
+    protected final Condition<T> toBeApplied;
+
+    public ConditionedExpressionDescription(Expression<T> toBeConditioned, Condition<T> toBeApplied) {
+        this.toBeConditioned = toBeConditioned;
+        this.toBeApplied = toBeApplied;
+    }
+
+    public abstract <V extends MetricSpace<V>> String describe(Context context, ExtendGiving<V> direction);
+
+}

src/main/java/net/itarray/automotion/internal/properties/StandardConditionedExpressionDescription.java

@@ -0,0 +1,22 @@
+package net.itarray.automotion.internal.properties;
+
+import net.itarray.automotion.internal.geometry.ExtendGiving;
+import net.itarray.automotion.internal.geometry.MetricSpace;
+import net.itarray.automotion.validation.properties.Condition;
+import net.itarray.automotion.validation.properties.Expression;
+
+public class StandardConditionedExpressionDescription<T> extends ConditionedExpressionDescription<T> {
+    public StandardConditionedExpressionDescription(Expression<T> toBeConditioned, Condition<T> toBeApplied) {
+        super(toBeConditioned, toBeApplied);
+    }
+
+    public <V extends MetricSpace<V>> String describe(Context context, ExtendGiving<V> direction) {
+        T t = toBeConditioned.evaluateIn(context, direction);
+        return String.format("Expected %s to be %s. Actual %s is: %s",
+                toBeConditioned.getDescription(context, direction),
+                toBeApplied.getDescription(context, direction),
+                toBeConditioned.getRepeatedDescription(context, direction),
+                (t instanceof MetricSpace) ? ((MetricSpace) t).toStringWithUnits("px") : t);
+    }
+
+}

src/main/java/net/itarray/automotion/internal/properties/SuccessorConditionedExpressionDescription.java

@@ -0,0 +1,25 @@
+package net.itarray.automotion.internal.properties;
+
+import net.itarray.automotion.internal.geometry.Direction;
+import net.itarray.automotion.internal.geometry.ExtendGiving;
+import net.itarray.automotion.internal.geometry.MetricSpace;
+import net.itarray.automotion.validation.properties.Condition;
+import net.itarray.automotion.validation.properties.Expression;
+
+public class SuccessorConditionedExpressionDescription<T> extends ConditionedExpressionDescription<T> {
+    private final Direction direction;
+
+    public SuccessorConditionedExpressionDescription(Expression<T> toBeConditioned, Condition<T> toBeApplied, Direction direction) {
+        super(toBeConditioned, toBeApplied);
+        this.direction = direction;
+    }
+
+
+    public <V extends MetricSpace<V>> String describe(Context context, ExtendGiving<V> extendGiving) {
+        T t = toBeConditioned.evaluateIn(context, extendGiving);
+        return String.format(direction.afterName() + " element aligned not properly. Expected margin should be %s. Actual margin is %s",
+                toBeApplied.getDescription(context, extendGiving),
+                (t instanceof MetricSpace) ? ((MetricSpace) t).toStringWithUnits("px") : t);
+    }
+
+}

src/main/java/net/itarray/automotion/validation/properties/Condition.java

@@ -1,19 +1,16 @@
 package net.itarray.automotion.validation.properties;
 
-import net.itarray.automotion.internal.geometry.Direction;
 import net.itarray.automotion.internal.geometry.ExtendGiving;
 import net.itarray.automotion.internal.geometry.MetricSpace;
 import net.itarray.automotion.internal.geometry.Scalar;
 import net.itarray.automotion.internal.properties.Between;
 import net.itarray.automotion.internal.properties.BinaryScalarConditionWithFixedOperand;
+import net.itarray.automotion.internal.properties.ConditionedExpressionDescription;
 import net.itarray.automotion.internal.properties.ConditionedExpression;
-import net.itarray.automotion.internal.properties.ConstantExpression;
 import net.itarray.automotion.internal.properties.Context;
 import net.itarray.automotion.internal.properties.ContextBiFunction;
 import net.itarray.automotion.internal.properties.PixelConstant;
 
-import java.util.function.BiPredicate;
-
 import static net.itarray.automotion.internal.geometry.Scalar.scalar;
 
 public interface Condition<T> {
@@ -127,8 +124,8 @@ default Expression<Boolean> applyTo(Expression<T> toBeConditioned) {
         return new ConditionedExpression<>(toBeConditioned, this);
     }
 
-    default Expression<Boolean> applyTo(Expression<T> toBeConditioned, String messageFormat) {
-        return new ConditionedExpression<>(toBeConditioned, this, messageFormat);
+    default Expression<Boolean> applyTo(Expression<T> toBeConditioned, ConditionedExpressionDescription<T> description) {
+        return new ConditionedExpression<>(toBeConditioned, this, description);
     }
 
     <V extends MetricSpace<V>> String getDescription(Context context, ExtendGiving<V> direction);