Changeset 14140 in josm for trunk/src/org/openstreetmap/josm

Timestamp:

2018-08-12T13:08:27+02:00 (6 years ago)

Author:

Don-vip

Message:

see #15229 - move Main* termination methods to lifecycle SPI + new class MainTermination

Location:

trunk/src/org/openstreetmap/josm

Files:

• Main.java (modified) (5 diffs)
• gui/MainApplication.java (modified) (5 diffs)
• gui/MainInitialization.java (modified) (3 diffs)
• gui/MainTermination.java (added)
• spi/lifecycle/Lifecycle.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/Main.java

@@ -2 +2 @@
 package org.openstreetmap.josm;
 
-import static org.openstreetmap.josm.tools.I18n.tr;
-
 import java.awt.Component;
-import java.io.IOException;
 import java.net.URL;
-import java.nio.file.InvalidPathException;
 import java.util.Collection;
 import java.util.Collections;
@@ -15 +11 @@
 import org.openstreetmap.josm.data.Preferences;
 import org.openstreetmap.josm.data.UndoRedoHandler;
-import org.openstreetmap.josm.data.coor.conversion.CoordinateFormatManager;
-import org.openstreetmap.josm.data.coor.conversion.DecimalDegreesCoordinateFormat;
-import org.openstreetmap.josm.data.coor.conversion.ICoordinateFormat;
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.data.osm.IPrimitive;
@@ -29 +22 @@
 import org.openstreetmap.josm.io.NetworkManager;
 import org.openstreetmap.josm.io.OnlineResource;
+import org.openstreetmap.josm.spi.lifecycle.Lifecycle;
 import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.spi.preferences.IUrls;
-import org.openstreetmap.josm.tools.ImageProvider;
-import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.PlatformHook;
 import org.openstreetmap.josm.tools.PlatformManager;
@@ -148 +140 @@
 
     /**
-     * Should be called before the main constructor to setup some parameter stuff
-     */
-    public static void preConstructorInit() {
-        // init default coordinate format
-        ICoordinateFormat fmt = CoordinateFormatManager.getCoordinateFormat(Config.getPref().get("coordinates"));
-        if (fmt == null) {
-            fmt = DecimalDegreesCoordinateFormat.INSTANCE;
-        }
-        CoordinateFormatManager.setCoordinateFormat(fmt);
-    }
-
-    /**
      * Closes JOSM and optionally terminates the Java Virtual Machine (JVM).
      * @param exit If {@code true}, the JVM is terminated by running {@link System#exit} with a given return code.
@@ -165 +145 @@
      * @return {@code true}
      * @since 12636
-     */
+     * @deprecated Use {@link Lifecycle#exitJosm}
+     */
+    @Deprecated
     public static boolean exitJosm(boolean exit, int exitCode) {
-        if (Main.main != null) {
-            Main.main.shutdown();
-        }
-
-        if (exit) {
-            System.exit(exitCode);
-        }
-        return true;
-    }
-
-    /**
-     * Shutdown JOSM.
-     */
-    protected void shutdown() {
-        ImageProvider.shutdown(false);
-        try {
-            pref.saveDefaults();
-        } catch (IOException | InvalidPathException ex) {
-            Logging.log(Logging.LEVEL_WARN, tr("Failed to save default preferences."), ex);
-        }
-        ImageProvider.shutdown(true);
+        return Lifecycle.exitJosm(exit, exitCode);
     }
 

trunk/src/org/openstreetmap/josm/gui/MainApplication.java

@@ -87 +87 @@
 import org.openstreetmap.josm.data.UndoRedoHandler.CommandQueueListener;
 import org.openstreetmap.josm.data.Version;
-import org.openstreetmap.josm.data.cache.JCSCacheManager;
 import org.openstreetmap.josm.data.oauth.OAuthAccessTokenHolder;
 import org.openstreetmap.josm.data.osm.DataSet;
@@ -347 +346 @@
         getLayerManager().addLayerChangeListener(undoRedoCleaner);
         ProjectionRegistry.setboundsProvider(mainBoundsProvider);
+        Lifecycle.setShutdownSequence(new MainTermination(this));
     }
 
@@ -409 +409 @@
     }
 
-    @Override
-    protected void shutdown() {
-        try {
-            worker.shutdown();
-        } catch (SecurityException e) {
-            Logging.log(Logging.LEVEL_ERROR, "Unable to shutdown worker", e);
-        }
-        JCSCacheManager.shutdown();
-
-        if (mainFrame != null) {
-            mainFrame.storeState();
-        }
-        if (map != null) {
-            map.rememberToggleDialogWidth();
-        }
-        // Remove all layers because somebody may rely on layerRemoved events (like AutosaveTask)
-        layerManager.resetState();
-        super.shutdown();
-
-        try {
-            // in case the current task still hasn't finished
-            worker.shutdownNow();
-        } catch (SecurityException e) {
-            Logging.log(Logging.LEVEL_ERROR, "Unable to shutdown worker", e);
-        }
+    /**
+     * Returns the JOSM main frame.
+     * @return the JOSM main frame
+     * @since 14140
+     */
+    public final MainFrame getMainFrame() {
+        return mainFrame;
     }
 
@@ -566 +548 @@
                         reason != null ? reason : SaveLayersDialog.Reason.EXIT)));
         if (proceed) {
-            return Main.exitJosm(exit, exitCode);
+            return Lifecycle.exitJosm(exit, exitCode);
         }
         return false;
@@ -980 +962 @@
         setupNadGridSources();
         GuiHelper.translateJavaInternalMessages();
-        preConstructorInit();
 
         monitor.indeterminateSubTask(tr("Creating main GUI"));

trunk/src/org/openstreetmap/josm/gui/MainInitialization.java

@@ -14 +14 @@
 import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
 import org.openstreetmap.josm.data.UndoRedoHandler;
+import org.openstreetmap.josm.data.coor.conversion.CoordinateFormatManager;
+import org.openstreetmap.josm.data.coor.conversion.DecimalDegreesCoordinateFormat;
+import org.openstreetmap.josm.data.coor.conversion.ICoordinateFormat;
 import org.openstreetmap.josm.data.validation.OsmValidator;
 import org.openstreetmap.josm.gui.layer.ImageryLayer;
@@ -28 +31 @@
 import org.openstreetmap.josm.spi.lifecycle.InitializationSequence;
 import org.openstreetmap.josm.spi.lifecycle.InitializationTask;
+import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.I18n;
 import org.openstreetmap.josm.tools.Logging;
@@ -57 +61 @@
     public List<InitializationTask> beforeInitializationTasks() {
         return Arrays.asList(
+            new InitializationTask(tr("Initializing coordinate format"), () -> {
+                ICoordinateFormat fmt = CoordinateFormatManager.getCoordinateFormat(Config.getPref().get("coordinates"));
+                if (fmt == null) {
+                    fmt = DecimalDegreesCoordinateFormat.INSTANCE;
+                }
+                CoordinateFormatManager.setCoordinateFormat(fmt);
+            }),
             new InitializationTask(tr("Starting file watcher"), FileWatcher.getDefaultInstance()::start),
             new InitializationTask(tr("Executing platform startup hook"),

trunk/src/org/openstreetmap/josm/spi/lifecycle/Lifecycle.java

@@ -9 +9 @@
 import java.util.concurrent.Future;
 
+import org.openstreetmap.josm.tools.JosmRuntimeException;
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Utils;
@@ -20 +21 @@
 
     private static volatile InitStatusListener initStatusListener;
+
+    private static volatile Runnable shutdownSequence;
 
     private Lifecycle() {
@@ -39 +42 @@
     public static void setInitStatusListener(InitStatusListener listener) {
         initStatusListener = Objects.requireNonNull(listener);
+    }
+
+    /**
+     * Gets shutdown sequence.
+     * @return shutdown sequence
+     * @since 14140
+     */
+    public static Runnable getShutdownSequence() {
+        return shutdownSequence;
+    }
+
+    /**
+     * Sets shutdown sequence.
+     * @param sequence shutdown sequence. Must not be null
+     * @since 14140
+     */
+    public static void setShutdownSequence(Runnable sequence) {
+        shutdownSequence = Objects.requireNonNull(sequence);
     }
 
@@ -66 +87 @@
             }
         } catch (InterruptedException | ExecutionException ex) {
-            throw new RuntimeException(ex);
+            throw new JosmRuntimeException(ex);
         }
 
@@ -77 +98 @@
             try {
                 task.call();
-            } catch (RuntimeException e) {
+            } catch (JosmRuntimeException e) {
                 // Can happen if the current projection needs NTV2 grid which is not available
                 // In this case we want the user be able to change his projection
@@ -84 +105 @@
         }
     }
+
+    /**
+     * Closes JOSM and optionally terminates the Java Virtual Machine (JVM).
+     * @param exit If {@code true}, the JVM is terminated by running {@link System#exit} with a given return code.
+     * @param exitCode The return code
+     * @return {@code true}
+     * @since 14140
+     */
+    public static boolean exitJosm(boolean exit, int exitCode) {
+        if (shutdownSequence != null) {
+            shutdownSequence.run();
+        }
+
+        if (exit) {
+            System.exit(exitCode);
+        }
+        return true;
+    }
 }