Changeset 9621 in josm for trunk/src/org/openstreetmap/josm/plugins

Timestamp:

2016-01-25T00:36:01+01:00 (8 years ago)

Author:

Don-vip

Message:

see #10588 - properly manage exception feedback in PluginDownloadTask. Removes a Findbugs warning

Location:

trunk/src/org/openstreetmap/josm/plugins

Files:

• PluginDownloadException.java (modified) (1 diff)
• PluginDownloadTask.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/plugins/PluginDownloadException.java

@@ -2 +2 @@
 package org.openstreetmap.josm.plugins;
 
+/**
+ * Exception thrown during plugin download.
+ * @since 2817
+ */
 public class PluginDownloadException extends Exception {
 
-    public PluginDownloadException() {
-        super();
+    /**
+     * Constructs a new {@code PluginDownloadException} with the specified detail message and cause.
+     * @param message message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
+     * @param cause cause the cause (which is saved for later retrieval by the {@link #getCause()} method).
+     */
+    public PluginDownloadException(String message, Throwable cause) {
+        super(message, cause);
     }
 
-    public PluginDownloadException(String arg0, Throwable arg1) {
-        super(arg0, arg1);
+    /**
+     * Constructs a new {@code PluginDownloadException} with the specified detail message.
+     * The cause is not initialized, and may subsequently be initialized by a call to {@link #initCause}.
+     * @param message message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
+     */
+    public PluginDownloadException(String message) {
+        super(message);
     }
 
-    public PluginDownloadException(String arg0) {
-        super(arg0);
-    }
-
-    public PluginDownloadException(Throwable arg0) {
-        super(arg0);
+    /**
+     * Constructs a new {@code PluginDownloadException} with the specified cause and a detail message of
+     * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
+     * @param cause cause the cause (which is saved for later retrieval by the {@link #getCause()} method).
+     */
+    public PluginDownloadException(Throwable cause) {
+        super(cause);
     }
 }

trunk/src/org/openstreetmap/josm/plugins/PluginDownloadTask.java

@@ -30 +30 @@
  * When the task is finished {@link #getDownloadedPlugins()} replies the list of downloaded plugins
  * and {@link #getFailedPlugins()} replies the list of failed plugins.
- *
+ * @since 2817
  */
 public class PluginDownloadTask extends PleaseWaitRunnable {
@@ -43 +43 @@
     private final Collection<PluginInformation> failed = new LinkedList<>();
     private final Collection<PluginInformation> downloaded = new LinkedList<>();
+    private Exception lastException;
     private boolean canceled;
     private HttpClient downloadConnection;
@@ -97 +98 @@
 
     @Override
-    protected void finish() {}
+    protected void finish() {
+        // Do nothing. Error/success feedback is managed in PluginPreference.notifyDownloadResults()
+    }
 
     protected void download(PluginInformation pi, File file) throws PluginDownloadException {
@@ -150 +153 @@
         File pluginDir = Main.pref.getPluginsDirectory();
         if (!pluginDir.exists() && !pluginDir.mkdirs()) {
-            /*lastException =*/ new PluginDownloadException(tr("Failed to create plugin directory ''{0}''", pluginDir.toString()));
+            String message = tr("Failed to create plugin directory ''{0}''", pluginDir.toString());
+            lastException = new PluginDownloadException(message);
+            Main.error(message);
             failed.addAll(toUpdate);
             return;
@@ -156 +161 @@
         getProgressMonitor().setTicksCount(toUpdate.size());
         for (PluginInformation d : toUpdate) {
-            if (canceled) return;
+            if (canceled)
+                return;
             String message = tr("Downloading Plugin {0}...", d.name);
             Main.info(message);
@@ -165 +171 @@
                 download(d, pluginFile);
             } catch (PluginDownloadException e) {
+                lastException = e;
                 Main.error(e);
                 failed.add(d);
@@ -200 +207 @@
         return downloaded;
     }
+
+    /**
+     * Replies the last exception that occured during download, or {@code null}.
+     * @return the last exception that occured during download, or {@code null}
+     * @since 9621
+     */
+    public Exception getLastException() {
+        return lastException;
+    }
 }