chore!: Remove ComponentEffect.format (#22230)

Fixes #22167

Author: Legioth

flow-server/src/main/java/com/vaadin/flow/component/ComponentEffect.java

@@ -15,12 +15,9 @@
  */
 package com.vaadin.flow.component;
 
-import java.util.Locale;
 import java.util.Objects;
-import java.util.stream.Stream;
 
 import com.vaadin.flow.function.SerializableBiConsumer;
-import com.vaadin.flow.internal.LocaleUtil;
 import com.vaadin.flow.server.ErrorEvent;
 import com.vaadin.flow.shared.Registration;
 import com.vaadin.signals.Signal;
@@ -35,7 +32,7 @@
  * {@link Signal#effect(Runnable)}, that is automatically enabled when a
  * component is attached and disabled when the component is detached.
  * Additionally it provides methods to bind signals to component according to a
- * given value setting function and format strings based on signal values.
+ * given value setting function.
  *
  * @since 24.8
  */
@@ -137,97 +134,6 @@ public static <C extends Component, T> Registration bind(C owner,
         });
     }
 
-    /**
-     * Formats a string using the values of the provided signals and the given
-     * locale, sets the formatted string on the owner component using the
-     * provided setter function.
-     * <p>
-     * Binds a formatted string using the values of the provided signals to a
-     * given owner component in a way defined in <code>setter</code> function
-     * and creates a Signal effect function executing the setter whenever the
-     * signal value changes.
-     * <p>
-     * Example of usage:
-     *
-     * <pre>
-     * ComponentEffect.format(mySpan, Span::setText, Locale.US,
-     *         "The price of %s is %.2f", nameSignal, priceSignal);
-     * </pre>
-     *
-     * @see Signal#effect(Runnable)
-     * @param owner
-     *            the owner component for which the effect is applied, must not
-     *            be <code>null</code>
-     * @param setter
-     *            the setter function that defines how the formatted string is
-     *            applied to the component, must not be <code>null</code>
-     * @param locale
-     *            the locale to be used for formatting the string, if
-     *            <code>null</code>, then no localization is applied
-     * @param format
-     *            the format string to be used for formatting the signal values,
-     *            must not be <code>null</code>
-     * @param signals
-     *            the signals whose values are to be used for formatting the
-     *            string, must not be <code>null</code>
-     * @return a {@link Registration} that can be used to remove the effect
-     *         function
-     * @param <C>
-     *            the type of the component
-     */
-    public static <C extends Component> Registration format(C owner,
-            SerializableBiConsumer<C, String> setter, Locale locale,
-            String format, Signal<?>... signals) {
-        return effect(owner, () -> {
-            Object[] values = Stream.of(signals).map(Signal::value).toArray();
-            setter.accept(owner, String.format(locale, format, values));
-        });
-    }
-
-    /**
-     * Formats a string using the values of the provided signals and sets it on
-     * the owner component using the provided setter function.
-     * <p>
-     * Binds a formatted string using the values of the provided signals to a
-     * given owner component in a way defined in <code>setter</code> function
-     * and creates a Signal effect function executing the setter whenever the
-     * signal value changes.
-     * <p>
-     * Formats using locale from the current UI, I18NProvider or default locale
-     * depending on what is available.
-     * <p>
-     * Example of usage:
-     *
-     * <pre>
-     * ComponentEffect.format(mySpan, Span::setText, "The price of %s is %.2f",
-     *         nameSignal, priceSignal);
-     * </pre>
-     *
-     * @see Signal#effect(Runnable)
-     * @param owner
-     *            the owner component for which the effect is applied, must not
-     *            be <code>null</code>
-     * @param setter
-     *            the setter function that defines how the formatted string is
-     *            applied to the component, must not be <code>null</code>
-     * @param format
-     *            the format string to be used for formatting the signal values,
-     *            must not be <code>null</code>
-     * @param signals
-     *            the signals whose values are to be used for formatting the
-     *            string, must not be <code>null</code>
-     * @return a {@link Registration} that can be used to remove the effect
-     *         function
-     * @param <C>
-     *            the type of the component
-     */
-    public static <C extends Component> Registration format(C owner,
-            SerializableBiConsumer<C, String> setter, String format,
-            Signal<?>... signals) {
-        Locale locale = LocaleUtil.getLocale();
-        return format(owner, setter, locale, format, signals);
-    }
-
     private void enableEffect(Component owner) {
         if (closed) {
             return;

flow-server/src/test/java/com/vaadin/flow/component/ComponentEffectTest.java

@@ -25,7 +25,6 @@
 import static org.mockito.Mockito.when;
 
 import java.util.ArrayList;
-import java.util.Locale;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
@@ -44,7 +43,6 @@
 import com.vaadin.flow.server.VaadinService;
 import com.vaadin.flow.server.VaadinSession;
 import com.vaadin.flow.shared.Registration;
-import com.vaadin.signals.NumberSignal;
 import com.vaadin.signals.ValueSignal;
 import com.vaadin.tests.util.MockUI;
 
@@ -277,68 +275,6 @@ public void bind_signalValueChanges_componentUpdated() {
         });
     }
 
-    @Test
-    public void format_customLocale_signalValuesChange_formattedStringUpdated() {
-        runWithFeatureFlagEnabled(() -> {
-            TestComponent component = new TestComponent();
-
-            MockUI ui = new MockUI();
-            ui.add(component);
-
-            ValueSignal<String> stringSignal = new ValueSignal<>("test");
-            NumberSignal numberSignal = new NumberSignal(42.23456);
-
-            Registration registration = ComponentEffect.format(component,
-                    TestComponent::setValue, Locale.ENGLISH,
-                    "The price of %s is %.2f", stringSignal, numberSignal);
-
-            assertEquals("Initial formatted value should be set",
-                    "The price of test is 42.23", component.getValue());
-
-            // Change int signal value
-            numberSignal.value(20.12345);
-
-            assertEquals(
-                    "Formatted value should be updated with new numeric value",
-                    "The price of test is 20.12", component.getValue());
-
-            // Change string signal value
-            stringSignal.value("updated");
-
-            assertEquals(
-                    "Formatted value should be updated with new string value",
-                    "The price of updated is 20.12", component.getValue());
-
-            registration.remove();
-
-            numberSignal.value(30.3456);
-            stringSignal.value("final");
-
-            assertEquals(
-                    "Formatted value should not be updated after registration is removed",
-                    "The price of updated is 20.12", component.getValue());
-        });
-    }
-
-    @Test
-    public void format_defaultLocale_signalValuesChange_formattedStringUpdated() {
-        runWithFeatureFlagEnabled(() -> {
-            TestComponent component = new TestComponent();
-
-            MockUI ui = new MockUI();
-            ui.add(component);
-
-            ValueSignal<String> stringSignal = new ValueSignal<>("test");
-            ValueSignal<Integer> numberSignal = new ValueSignal<>(42);
-
-            ComponentEffect.format(component, TestComponent::setValue,
-                    "The price of %s is %d", stringSignal, numberSignal);
-
-            assertEquals("Initial formatted value should be set",
-                    "The price of test is 42", component.getValue());
-        });
-    }
-
     @FunctionalInterface
     private interface InterruptableRunnable {
         void run() throws InterruptedException;