Merge pull request #380 from greboid/master

Switch lots of things to use the new RunnableLoggingSwingWorker.

ui_swing/src/com/dmdirc/addons/ui_swing/components/FontPicker.java

@@ -24,16 +24,13 @@ package com.dmdirc.addons.ui_swing.components;
 
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.addons.ui_swing.components.renderers.FontListCellRenderer;
-import com.dmdirc.events.UserErrorEvent;
-import com.dmdirc.logger.ErrorLevel;
 
 import java.awt.Font;
 import java.awt.GraphicsEnvironment;
-import java.util.concurrent.ExecutionException;
 
 import javax.swing.DefaultComboBoxModel;
 import javax.swing.JComboBox;
-import javax.swing.SwingUtilities;
+import javax.swing.MutableComboBoxModel;
 
 /**
  * System font picking component.
@@ -56,25 +53,9 @@ public class FontPicker extends JComboBox<Object> {
         this.fontFamily = fontFamily;
 
         setRenderer(new FontListCellRenderer(getRenderer()));
-        new LoggingSwingWorker<String[], String[]>(eventBus) {
-
-            @Override
-            protected String[] doInBackground() {
-                return GraphicsEnvironment.getLocalGraphicsEnvironment().
-                        getAvailableFontFamilyNames();
-            }
-
-            @Override
-            protected void done() {
-                try {
-                    loadFonts(get());
-                } catch (InterruptedException ex) {
-                    //Ignore
-                } catch (ExecutionException ex) {
-                    eventBus.publishAsync(new UserErrorEvent(ErrorLevel.MEDIUM, ex, ex.getMessage(), ""));
-                }
-            }
-        }.execute();
+        new RunnableLoggingSwingWorker<String[], String[]>(eventBus,
+                () -> GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames(),
+                this::loadFonts).execute();
     }
 
     /**
@@ -85,10 +66,9 @@ public class FontPicker extends JComboBox<Object> {
     private void loadFonts(final String... fonts) {
         final int size = getFont().getSize();
         for (final String font : fonts) {
-            SwingUtilities.invokeLater(() -> ((DefaultComboBoxModel<Object>) getModel()).addElement(new Font(
-                    font, Font.PLAIN, size)));
+            ((MutableComboBoxModel<Object>) getModel()).addElement(new Font(font, Font.PLAIN, size));
         }
-        SwingUtilities.invokeLater(() -> setSelectedItem(new Font(fontFamily, Font.PLAIN, size)));
+        setSelectedItem(new Font(fontFamily, Font.PLAIN, size));
     }
 
 }

ui_swing/src/com/dmdirc/addons/ui_swing/components/RunnableLoggingSwingWorker.java

@@ -24,26 +24,51 @@ package com.dmdirc.addons.ui_swing.components;
 
 import com.dmdirc.DMDircMBassador;
 
+import java.util.List;
+import java.util.function.Consumer;
+
 /**
  * {@link LoggingSwingWorker} that runs a {@link Runnable}.
  */
-public class RunnableLoggingSwingWorker<T, V> extends LoggingSwingWorker<T, V> {
+public class RunnableLoggingSwingWorker<T, V> extends SupplierLoggingSwingWorker<T, V> {
 
-    private final Runnable runnable;
+    /**
+     * Creates a new logging swing worker.
+     *
+     * @param eventBus           Event bus to post errors to.
+     * @param backgroundRunnable The runnable to call as the background task, off the EDT.
+     */
+    public RunnableLoggingSwingWorker(final DMDircMBassador eventBus,
+            final Runnable backgroundRunnable) {
+        this(eventBus, backgroundRunnable, result -> {});
+    }
 
     /**
      * Creates a new logging swing worker.
      *
-     * @param eventBus Event bus to post errors to.
+     * @param eventBus           Event bus to post errors to.
+     * @param backgroundRunnable The runnable to call as the background task, off the EDT.
+     * @param doneConsumer       The consumer called when the background task is complete
      */
-    public RunnableLoggingSwingWorker(final DMDircMBassador eventBus, final Runnable runnable) {
-        super(eventBus);
-        this.runnable = runnable;
+    public RunnableLoggingSwingWorker(final DMDircMBassador eventBus,
+            final Runnable backgroundRunnable,
+            final Consumer<T> doneConsumer) {
+        this(eventBus, backgroundRunnable, doneConsumer, chunks -> {});
     }
 
-    @Override
-    protected T doInBackground() throws Exception {
-        runnable.run();
-        return null;
+    /**
+     * Creates a new logging swing worker.
+     *
+     * @param eventBus           Event bus to post errors to.
+     * @param backgroundRunnable The runnable to call as the background task, off the EDT.
+     * @param doneConsumer       The consumer called when the background task is complete
+     * @param processConsumer    The consumer called to process results of the background task
+     *                           as it progresses
+     */
+    public RunnableLoggingSwingWorker(final DMDircMBassador eventBus,
+            final Runnable backgroundRunnable,
+            final Consumer<T> doneConsumer,
+            final Consumer<List<V>> processConsumer) {
+        super(eventBus, () -> { backgroundRunnable.run(); return null; } , doneConsumer, processConsumer);
     }
 }

ui_swing/src/com/dmdirc/addons/ui_swing/components/SupplierLoggingSwingWorker.java

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.components;
+
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.events.UserErrorEvent;
+import com.dmdirc.logger.ErrorLevel;
+
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+/**
+ * {@link LoggingSwingWorker} that runs a {@link Supplier}.
+ */
+public class SupplierLoggingSwingWorker<T, V> extends LoggingSwingWorker<T, V> {
+
+    private final DMDircMBassador eventBus;
+    private final Consumer<T> doneConsumer;
+    private final Consumer<List<V>> processConsumer;
+    private final Supplier<T> backgroundSupplier;
+
+    /**
+     * Creates a new logging swing worker.
+     *
+     * @param eventBus           Event bus to post errors to.
+     * @param backgroundSupplier The supplier to call as the background task, off the EDT.
+     */
+    public SupplierLoggingSwingWorker(final DMDircMBassador eventBus,
+            final Supplier<T> backgroundSupplier) {
+        this(eventBus, backgroundSupplier, result -> {});
+    }
+
+    /**
+     * Creates a new logging swing worker.
+     *
+     * @param eventBus           Event bus to post errors to.
+     * @param backgroundSupplier The supplier to call as the background task, off the EDT.
+     * @param doneConsumer       The consumer called when the background task is complete
+     */
+    public SupplierLoggingSwingWorker(final DMDircMBassador eventBus,
+            final Supplier<T> backgroundSupplier,
+            final Consumer<T> doneConsumer) {
+        this(eventBus, backgroundSupplier, doneConsumer, chunks -> {});
+    }
+
+    /**
+     * Creates a new logging swing worker.
+     *
+     * @param eventBus           Event bus to post errors to.
+     * @param backgroundSupplier The supplier to call as the background task, off the EDT.
+     * @param doneConsumer       The consumer called when the background task is complete
+     * @param processConsumer    The consumer called to process results of the background task
+     *                           as it progresses
+     */
+    public SupplierLoggingSwingWorker(final DMDircMBassador eventBus,
+            final Supplier<T> backgroundSupplier,
+            final Consumer<T> doneConsumer,
+            final Consumer<List<V>> processConsumer) {
+        super(eventBus);
+        this.eventBus = eventBus;
+        this.backgroundSupplier = backgroundSupplier;
+        this.doneConsumer = doneConsumer;
+        this.processConsumer = processConsumer;
+    }
+
+    @Override
+    protected T doInBackground() throws Exception {
+        return backgroundSupplier.get();
+    }
+
+    @Override
+    protected void process(final List<V> chunks) {
+        processConsumer.accept(chunks);
+    }
+
+    @Override
+    protected void done() {
+        try {
+            handleDone(get());
+        } catch (InterruptedException ex) {
+            //Ignore
+        } catch (ExecutionException ex) {
+            eventBus.publishAsync(new UserErrorEvent(ErrorLevel.MEDIUM, ex, ex.getMessage(), ""));
+        }
+    }
+
+    public void handleDone(final T value) {
+        doneConsumer.accept(value);
+    }
+}

ui_swing/src/com/dmdirc/addons/ui_swing/components/addonpanel/AddonPanel.java

@@ -23,8 +23,7 @@
 package com.dmdirc.addons.ui_swing.components.addonpanel;
 
 import com.dmdirc.DMDircMBassador;
-import com.dmdirc.addons.ui_swing.UIUtilities;
-import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
+import com.dmdirc.addons.ui_swing.components.RunnableLoggingSwingWorker;
 import com.dmdirc.addons.ui_swing.components.addonbrowser.BrowserWindow;
 import com.dmdirc.addons.ui_swing.components.addonbrowser.DataLoaderWorkerFactory;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
@@ -37,6 +36,7 @@ import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JTable;
 import javax.swing.ListSelectionModel;
+import javax.swing.ScrollPaneConstants;
 import javax.swing.event.HyperlinkEvent;
 import javax.swing.event.HyperlinkEvent.EventType;
 import javax.swing.event.HyperlinkListener;
@@ -111,10 +111,8 @@ public abstract class AddonPanel extends JPanel implements AddonToggleListener,
 
         scrollPane = new JScrollPane(new JLabel("Loading " + getTypeName()
                 + "..."));
-        scrollPane.setHorizontalScrollBarPolicy(
-                JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
-        scrollPane.setVerticalScrollBarPolicy(
-                JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);
+        scrollPane.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
+        scrollPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
 
         blurbLabel = new TextLabel(getTypeName().substring(0, 1).toUpperCase()
                 + getTypeName().substring(1) + " allow you to extend the "
@@ -130,24 +128,14 @@ public abstract class AddonPanel extends JPanel implements AddonToggleListener,
      * Populates the list in a background thread.
      */
     protected void load() {
-        new LoggingSwingWorker<Object, Object>(eventBus) {
-            @Override
-            protected Object doInBackground() {
-                return populateList(addonList);
-            }
-
-            @Override
-            protected void done() {
-                super.done();
-                scrollPane.setViewportView(addonList);
-                UIUtilities.invokeLater(() -> {
-                    addonList.getSelectionModel()
-                            .addListSelectionListener(AddonPanel.this);
-                    addonList.getSelectionModel()
-                            .setSelectionInterval(0, 0);
-                });
-            }
-        }.execute();
+        new RunnableLoggingSwingWorker<>(eventBus,
+                () -> populateList(addonList),
+                value -> {
+                    scrollPane.setViewportView(addonList);
+                    addonList.getSelectionModel().addListSelectionListener(this);
+                    addonList.getSelectionModel().setSelectionInterval(0, 0);
+                }
+        ).execute();
     }
 
     /** Lays out the dialog. */

ui_swing/src/com/dmdirc/addons/ui_swing/components/inputfields/SwingInputHandler.java

@@ -25,7 +25,7 @@ package com.dmdirc.addons.ui_swing.components.inputfields;
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.addons.ui_swing.Apple;
 import com.dmdirc.addons.ui_swing.UIUtilities;
-import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
+import com.dmdirc.addons.ui_swing.components.RunnableLoggingSwingWorker;
 import com.dmdirc.commandparser.parsers.CommandParser;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.WindowModel;
@@ -35,6 +35,7 @@ import com.dmdirc.ui.input.InputHandler;
 import com.dmdirc.ui.input.TabCompleterUtils;
 
 import java.awt.event.ActionEvent;
+import java.awt.event.InputEvent;
 import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
 
@@ -153,21 +154,11 @@ public class SwingInputHandler extends InputHandler implements KeyListener {
 
             @Override
             public void actionPerformed(final ActionEvent e) {
-                new LoggingSwingWorker<Object, Void>(eventBus) {
-
-                    @Override
-                    protected Object doInBackground() {
-                        localTarget.setEditable(false);
-                        doTabCompletion(false);
-                        return null;
-                    }
-
-                    @Override
-                    protected void done() {
-                        localTarget.setEditable(true);
-                        super.done();
-                    }
-                }.execute();
+                localTarget.setEditable(false);
+                new RunnableLoggingSwingWorker<>(eventBus,
+                        () -> doTabCompletion(false),
+                        value -> localTarget.setEditable(true)
+                ).execute();
             }
         });
         localTarget.getActionMap().put("insert-shift-tab",
@@ -177,28 +168,18 @@ public class SwingInputHandler extends InputHandler implements KeyListener {
 
                     @Override
                     public void actionPerformed(final ActionEvent e) {
-                        new LoggingSwingWorker<Object, Void>(eventBus) {
-
-                            @Override
-                            protected Object doInBackground() {
-                                localTarget.setEditable(false);
-                                doTabCompletion(true);
-                                return null;
-                            }
-
-                            @Override
-                            protected void done() {
-                                localTarget.setEditable(true);
-                                super.done();
-                            }
-                        }.execute();
+                        localTarget.setEditable(false);
+                        new RunnableLoggingSwingWorker<>(eventBus,
+                                () -> doTabCompletion(true),
+                                value -> localTarget.setEditable(true)
+                        ).execute();
                     }
                 });
         localTarget.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).
                 put(KeyStroke.getKeyStroke(KeyEvent.VK_TAB, 0), "insert-tab");
         localTarget.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).
-                put(KeyStroke.getKeyStroke(KeyEvent.VK_TAB,
-                                KeyEvent.SHIFT_MASK), "insert-shift-tab");
+                put(KeyStroke.getKeyStroke(KeyEvent.VK_TAB, InputEvent.SHIFT_MASK),
+                        "insert-shift-tab");
     }
 
     @Override
@@ -232,14 +213,7 @@ public class SwingInputHandler extends InputHandler implements KeyListener {
                                         "Event is not from known source.");
                     }
                     if (source.isEditable()) {
-                        new LoggingSwingWorker<Object, Void>(eventBus) {
-
-                            @Override
-                            protected Object doInBackground() {
-                                enterPressed(line);
-                                return null;
-                            }
-                        }.execute();
+                        new RunnableLoggingSwingWorker<>(eventBus, () -> enterPressed(line)).execute();
                     }
                 });
             }

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/prefs/SwingPreferencesDialog.java

@@ -24,8 +24,10 @@ package com.dmdirc.addons.ui_swing.dialogs.prefs;
 
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.addons.ui_swing.components.IconManager;
 import com.dmdirc.addons.ui_swing.components.ListScroller;
-import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
+import com.dmdirc.addons.ui_swing.components.RunnableLoggingSwingWorker;
+import com.dmdirc.addons.ui_swing.components.SupplierLoggingSwingWorker;
 import com.dmdirc.addons.ui_swing.dialogs.StandardDialog;
 import com.dmdirc.addons.ui_swing.dialogs.updater.SwingRestartDialog;
 import com.dmdirc.addons.ui_swing.injection.DialogModule.ForSettings;
@@ -35,12 +37,10 @@ import com.dmdirc.config.prefs.PreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesDialogModel;
 import com.dmdirc.events.UserErrorEvent;
 import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.addons.ui_swing.components.IconManager;
 
 import java.awt.Window;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import java.util.concurrent.ExecutionException;
 
 import javax.inject.Inject;
 import javax.inject.Provider;
@@ -51,6 +51,7 @@ import javax.swing.JList;
 import javax.swing.JScrollPane;
 import javax.swing.ListSelectionModel;
 import javax.swing.ScrollPaneConstants;
+import javax.swing.SwingWorker;
 import javax.swing.WindowConstants;
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
@@ -74,7 +75,7 @@ public final class SwingPreferencesDialog extends StandardDialog implements
     /** Preferences Manager. */
     private PreferencesDialogModel manager;
     /** Manager loading swing worker. */
-    private final LoggingSwingWorker<PreferencesDialogModel, Void> worker;
+    private final SwingWorker<PreferencesDialogModel, Void> worker;
     /** The provider to use for restart dialogs. */
     private final DialogProvider<SwingRestartDialog> restartDialogProvider;
     /** The provider to use to produce a category panel. */
@@ -111,41 +112,30 @@ public final class SwingPreferencesDialog extends StandardDialog implements
 
         initComponents();
 
-        worker = new LoggingSwingWorker<PreferencesDialogModel, Void>(eventBus) {
-
-            @Override
-            protected PreferencesDialogModel doInBackground() {
-                mainPanel.setWaiting(true);
-                PreferencesDialogModel prefsManager = null;
-                try {
-                    prefsManager = dialogModelProvider.get();
-                } catch (IllegalArgumentException ex) {
-                    mainPanel.setError(ex.getMessage());
-                    eventBus.publishAsync(new UserErrorEvent(ErrorLevel.HIGH, ex,
-                            "Unable to load the preferences dialog", ""));
-                }
-                return prefsManager;
-            }
-
-            @Override
-            protected void done() {
-                if (!isCancelled()) {
-                    try {
-                        final PreferencesDialogModel prefsManager = get();
-                        if (prefsManager != null) {
-                            setPrefsManager(prefsManager);
-                        }
-                    } catch (InterruptedException ex) {
-                        //Ignore
-                    } catch (ExecutionException ex) {
-                        eventBus.publishAsync(new UserErrorEvent(ErrorLevel.MEDIUM, ex, ex.getMessage(), ""));
+        worker = new SupplierLoggingSwingWorker<>(eventBus,
+                () -> getPrefsModel(dialogModelProvider),
+                value -> {
+                    if (value != null) {
+                        setPrefsManager(value);
                     }
-                }
-            }
-        };
+                });
         worker.execute();
     }
 
+    private PreferencesDialogModel getPrefsModel(
+            final Provider<PreferencesDialogModel> dialogModelProvider) {
+        mainPanel.setWaiting(true);
+        PreferencesDialogModel prefsManager = null;
+        try {
+            prefsManager = dialogModelProvider.get();
+        } catch (IllegalArgumentException ex) {
+            mainPanel.setError(ex.getMessage());
+            eventBus.publishAsync(new UserErrorEvent(ErrorLevel.HIGH, ex,
+                    "Unable to load the preferences dialog", ""));
+        }
+        return prefsManager;
+    }
+
     private void setPrefsManager(final PreferencesDialogModel manager) {
         this.manager = manager;
 
@@ -242,15 +232,11 @@ public final class SwingPreferencesDialog extends StandardDialog implements
             saveOptions();
         }
 
-        new LoggingSwingWorker<Void, Void>(eventBus) {
-            @Override
-            protected Void doInBackground() {
-                if (manager != null) {
-                    manager.dismiss();
-                }
-                return null;
+        new RunnableLoggingSwingWorker<>(eventBus, () -> {
+            if (manager != null) {
+                manager.dismiss();
             }
-        }.execute();
+        }).execute();
         dispose();
     }
 

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/updater/SwingUpdaterDialog.java

@@ -24,8 +24,8 @@ package com.dmdirc.addons.ui_swing.dialogs.updater;
 
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.addons.ui_swing.UIUtilities;
-import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
 import com.dmdirc.addons.ui_swing.components.PackingTable;
+import com.dmdirc.addons.ui_swing.components.RunnableLoggingSwingWorker;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
 import com.dmdirc.addons.ui_swing.dialogs.StandardDialog;
 import com.dmdirc.addons.ui_swing.injection.DialogModule.ForUpdates;
@@ -182,16 +182,10 @@ public class SwingUpdaterDialog extends StandardDialog implements
 
             header.setText("DMDirc is updating the following components:");
 
-            new LoggingSwingWorker<Void, Void>(eventBus) {
-
-                @Override
-                protected Void doInBackground() {
-                    ((UpdateTableModel) table.getModel()).getUpdates().stream()
-                            .filter(((UpdateTableModel) table.getModel())::isEnabled)
-                            .forEach(updateManager::install);
-                    return null;
-                }
-            }.execute();
+            new RunnableLoggingSwingWorker<>(eventBus,
+                    () -> ((UpdateTableModel) table.getModel()).getUpdates().stream()
+                    .filter(((UpdateTableModel) table.getModel())::isEnabled)
+                    .forEach(updateManager::install)).execute();
 
             if (updateManager.getManagerStatus() == UpdateManagerStatus.IDLE_RESTART_NEEDED) {
                 restartDialogProvider.displayOrRequestFocus();