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

Timestamp:

2016-03-02T22:54:34+01:00 (8 years ago)

Author:

Don-vip

Message:

ChangesetCacheManager: add unit tests

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/dialogs/changeset/ChangesetCacheManager.java (modified) (24 diffs)
• gui/dialogs/changeset/query/ChangesetQueryDialog.java (modified) (2 diffs)
• gui/util/GuiHelper.java (modified) (2 diffs)
• tools/Utils.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java

@@ -9 +9 @@
 import java.awt.Dimension;
 import java.awt.FlowLayout;
+import java.awt.GraphicsEnvironment;
+import java.awt.Window;
 import java.awt.event.ActionEvent;
 import java.awt.event.KeyEvent;
@@ -48 +50 @@
 import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.io.CloseChangesetTask;
+import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
 import org.openstreetmap.josm.io.ChangesetQuery;
@@ -60 +63 @@
  * downloading, querying, closing changesets, in addition to removing changesets from
  * the local cache.
- *
+ * @since 2689
  */
 public class ChangesetCacheManager extends JFrame {
@@ -86 +89 @@
 
     /**
-     * Hides and destroys the unique instance of the changeset cache
-     * manager.
+     * Hides and destroys the unique instance of the changeset cache manager.
      *
      */
@@ -109 +111 @@
 
     /**
-     * Creates the various models required
-     */
-    protected void buildModel() {
+     * Creates the various models required.
+     * @return the changeset cache model
+     */
+    static ChangesetCacheManagerModel buildModel() {
         DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
         selectionModel.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
-        model = new ChangesetCacheManagerModel(selectionModel);
-
-        actRemoveFromCacheAction = new RemoveFromCacheAction();
-        actCloseSelectedChangesetsAction = new CloseSelectedChangesetsAction();
-        actDownloadSelectedChangesets = new DownloadSelectedChangesetsAction();
-        actDownloadSelectedContent = new DownloadSelectedChangesetContentAction();
+        return new ChangesetCacheManagerModel(selectionModel);
     }
 
@@ -127 +125 @@
      * @return the toolbar panel
      */
-    protected JPanel buildToolbarPanel() {
+    static JPanel buildToolbarPanel() {
         JPanel pnl = new JPanel(new FlowLayout(FlowLayout.LEFT));
 
@@ -143 +141 @@
      * @return the button row pane
      */
-    protected JPanel buildButtonPanel() {
+    static JPanel buildButtonPanel() {
         JPanel pnl = new JPanel(new FlowLayout(FlowLayout.CENTER));
 
@@ -150 +148 @@
 
         //-- help action
-        pnl.add(new SideButton(
-                new ContextSensitiveHelpAction(
-                        HelpUtil.ht("/Dialog/ChangesetManager"))
-        )
-        );
+        pnl.add(new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Dialog/ChangesetManager"))));
 
         return pnl;
@@ -266 +260 @@
         tblChangesets.addMouseListener(new MouseEventHandler());
         tblChangesets.getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0), "showDetails");
-        tblChangesets.getActionMap().put("showDetails", new ShowDetailAction());
-        model.getSelectionModel().addListSelectionListener(new ChangesetDetailViewSynchronizer());
+        tblChangesets.getActionMap().put("showDetails", new ShowDetailAction(model));
+        model.getSelectionModel().addListSelectionListener(new ChangesetDetailViewSynchronizer(model));
 
         // activate DEL on the table
@@ -285 +279 @@
         cp.setLayout(new BorderLayout());
 
-        buildModel();
+        model = buildModel();
+        actRemoveFromCacheAction = new RemoveFromCacheAction(model);
+        actCloseSelectedChangesetsAction = new CloseSelectedChangesetsAction(model);
+        actDownloadSelectedChangesets = new DownloadSelectedChangesetsAction(model);
+        actDownloadSelectedContent = new DownloadSelectedChangesetContentAction(model);
+
         cp.add(buildToolbarPanel(), BorderLayout.NORTH);
         cp.add(buildContentPanel(), BorderLayout.CENTER);
@@ -340 +339 @@
 
         @Override
-        public void windowActivated(WindowEvent arg0) {
+        public void windowActivated(WindowEvent e) {
             if (needsSplitPaneAdjustment) {
                 spContent.setDividerLocation(0.5);
@@ -363 +362 @@
 
         @Override
-        public void actionPerformed(ActionEvent arg0) {
+        public void actionPerformed(ActionEvent e) {
             cancelAndClose();
         }
@@ -371 +370 @@
      * The action to query and download changesets
      */
-    class QueryAction extends AbstractAction {
+    static class QueryAction extends AbstractAction {
+
         QueryAction() {
             putValue(NAME, tr("Query"));
@@ -381 +381 @@
         @Override
         public void actionPerformed(ActionEvent evt) {
-            ChangesetQueryDialog dialog = new ChangesetQueryDialog(ChangesetCacheManager.this);
-            dialog.initForUserInput();
-            dialog.setVisible(true);
-            if (dialog.isCanceled())
-                return;
-
-            try {
-                ChangesetQuery query = dialog.getChangesetQuery();
-                if (query == null) return;
-                ChangesetQueryTask task = new ChangesetQueryTask(ChangesetCacheManager.this, query);
-                ChangesetCacheManager.getInstance().runDownloadTask(task);
-            } catch (IllegalStateException e) {
-                JOptionPane.showMessageDialog(ChangesetCacheManager.this, e.getMessage(), tr("Error"), JOptionPane.ERROR_MESSAGE);
+            Window parent = GuiHelper.getWindowAncestorFor(evt);
+            if (!GraphicsEnvironment.isHeadless()) {
+                ChangesetQueryDialog dialog = new ChangesetQueryDialog(parent);
+                dialog.initForUserInput();
+                dialog.setVisible(true);
+                if (dialog.isCanceled())
+                    return;
+
+                try {
+                    ChangesetQuery query = dialog.getChangesetQuery();
+                    if (query != null) {
+                        ChangesetCacheManager.getInstance().runDownloadTask(new ChangesetQueryTask(parent, query));
+                    }
+                } catch (IllegalStateException e) {
+                    JOptionPane.showMessageDialog(parent, e.getMessage(), tr("Error"), JOptionPane.ERROR_MESSAGE);
+                }
             }
         }
@@ -402 +405 @@
      *
      */
-    class RemoveFromCacheAction extends AbstractAction implements ListSelectionListener {
-        RemoveFromCacheAction() {
+    static class RemoveFromCacheAction extends AbstractAction implements ListSelectionListener {
+        private final ChangesetCacheManagerModel model;
+
+        RemoveFromCacheAction(ChangesetCacheManagerModel model) {
             putValue(NAME, tr("Remove from cache"));
             putValue(SMALL_ICON, ImageProvider.get("dialogs", "delete"));
             putValue(SHORT_DESCRIPTION, tr("Remove the selected changesets from the local cache"));
+            this.model = model;
             updateEnabledState();
         }
 
         @Override
-        public void actionPerformed(ActionEvent arg0) {
-            List<Changeset> selected = model.getSelectedChangesets();
-            ChangesetCache.getInstance().remove(selected);
+        public void actionPerformed(ActionEvent e) {
+            ChangesetCache.getInstance().remove(model.getSelectedChangesets());
         }
 
@@ -430 +435 @@
      *
      */
-    class CloseSelectedChangesetsAction extends AbstractAction implements ListSelectionListener {
-        CloseSelectedChangesetsAction() {
+    static class CloseSelectedChangesetsAction extends AbstractAction implements ListSelectionListener {
+        private final ChangesetCacheManagerModel model;
+
+        CloseSelectedChangesetsAction(ChangesetCacheManagerModel model) {
             putValue(NAME, tr("Close"));
             putValue(SMALL_ICON, ImageProvider.get("closechangeset"));
             putValue(SHORT_DESCRIPTION, tr("Close the selected changesets"));
+            this.model = model;
             updateEnabledState();
         }
 
         @Override
-        public void actionPerformed(ActionEvent arg0) {
-            List<Changeset> selected = model.getSelectedChangesets();
-            Main.worker.submit(new CloseChangesetTask(selected));
+        public void actionPerformed(ActionEvent e) {
+            Main.worker.submit(new CloseChangesetTask(model.getSelectedChangesets()));
         }
 
@@ -472 +479 @@
      *
      */
-    class DownloadSelectedChangesetsAction extends AbstractAction implements ListSelectionListener {
-        DownloadSelectedChangesetsAction() {
+    static class DownloadSelectedChangesetsAction extends AbstractAction implements ListSelectionListener {
+        private final ChangesetCacheManagerModel model;
+
+        DownloadSelectedChangesetsAction(ChangesetCacheManagerModel model) {
             putValue(NAME, tr("Update changeset"));
             putValue(SMALL_ICON, ImageProvider.get("dialogs/changeset", "updatechangeset"));
             putValue(SHORT_DESCRIPTION, tr("Updates the selected changesets with current data from the OSM server"));
+            this.model = model;
             updateEnabledState();
         }
 
         @Override
-        public void actionPerformed(ActionEvent arg0) {
-            List<Changeset> selected = model.getSelectedChangesets();
-            ChangesetHeaderDownloadTask task = ChangesetHeaderDownloadTask.buildTaskForChangesets(ChangesetCacheManager.this, selected);
-            ChangesetCacheManager.getInstance().runDownloadTask(task);
+        public void actionPerformed(ActionEvent e) {
+            if (!GraphicsEnvironment.isHeadless()) {
+                ChangesetCacheManager.getInstance().runDownloadTask(
+                        ChangesetHeaderDownloadTask.buildTaskForChangesets(GuiHelper.getWindowAncestorFor(e), model.getSelectedChangesets()));
+            }
         }
 
@@ -501 +512 @@
      *
      */
-    class DownloadSelectedChangesetContentAction extends AbstractAction implements ListSelectionListener {
-        DownloadSelectedChangesetContentAction() {
+    static class DownloadSelectedChangesetContentAction extends AbstractAction implements ListSelectionListener {
+        private final ChangesetCacheManagerModel model;
+
+        DownloadSelectedChangesetContentAction(ChangesetCacheManagerModel model) {
             putValue(NAME, tr("Download changeset content"));
             putValue(SMALL_ICON, DOWNLOAD_CONTENT_ICON);
             putValue(SHORT_DESCRIPTION, tr("Download the content of the selected changesets from the server"));
+            this.model = model;
             updateEnabledState();
         }
 
         @Override
-        public void actionPerformed(ActionEvent arg0) {
-            ChangesetContentDownloadTask task = new ChangesetContentDownloadTask(ChangesetCacheManager.this, model.getSelectedChangesetIds());
-            ChangesetCacheManager.getInstance().runDownloadTask(task);
+        public void actionPerformed(ActionEvent e) {
+            if (!GraphicsEnvironment.isHeadless()) {
+                ChangesetCacheManager.getInstance().runDownloadTask(
+                        new ChangesetContentDownloadTask(GuiHelper.getWindowAncestorFor(e), model.getSelectedChangesetIds()));
+            }
         }
 
@@ -525 +541 @@
     }
 
-    class ShowDetailAction extends AbstractAction {
-
-        public void showDetails() {
+    static class ShowDetailAction extends AbstractAction {
+        private final ChangesetCacheManagerModel model;
+
+        ShowDetailAction(ChangesetCacheManagerModel model) {
+            this.model = model;
+        }
+
+        protected void showDetails() {
             List<Changeset> selected = model.getSelectedChangesets();
-            if (selected.size() != 1) return;
-            model.setChangesetInDetailView(selected.get(0));
-        }
-
-        @Override
-        public void actionPerformed(ActionEvent arg0) {
+            if (selected.size() == 1) {
+                model.setChangesetInDetailView(selected.get(0));
+            }
+        }
+
+        @Override
+        public void actionPerformed(ActionEvent e) {
             showDetails();
         }
     }
 
-    class DownloadMyChangesets extends AbstractAction {
+    static class DownloadMyChangesets extends AbstractAction {
         DownloadMyChangesets() {
             putValue(NAME, tr("My changesets"));
@@ -547 +569 @@
         }
 
-        protected void alertAnonymousUser() {
+        protected void alertAnonymousUser(Component parent) {
             HelpAwareOptionPane.showOptionDialog(
-                    ChangesetCacheManager.this,
+                    parent,
                     tr("<html>JOSM is currently running with an anonymous user. It cannot download<br>"
                             + "your changesets from the OSM server unless you enter your OSM user name<br>"
@@ -561 +583 @@
 
         @Override
-        public void actionPerformed(ActionEvent arg0) {
+        public void actionPerformed(ActionEvent e) {
+            Window parent = GuiHelper.getWindowAncestorFor(e);
             JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
             if (im.isAnonymous()) {
-                alertAnonymousUser();
+                alertAnonymousUser(parent);
                 return;
             }
@@ -573 +596 @@
                 query = query.forUser(im.getUserName());
             }
-            ChangesetQueryTask task = new ChangesetQueryTask(ChangesetCacheManager.this, query);
-            ChangesetCacheManager.getInstance().runDownloadTask(task);
+            if (!GraphicsEnvironment.isHeadless()) {
+                ChangesetCacheManager.getInstance().runDownloadTask(new ChangesetQueryTask(parent, query));
+            }
         }
     }
@@ -587 +611 @@
         public void mouseClicked(MouseEvent evt) {
             if (isDoubleClick(evt)) {
-                new ShowDetailAction().showDetails();
+                new ShowDetailAction(model).showDetails();
             }
         }
@@ -601 +625 @@
     }
 
-    class ChangesetDetailViewSynchronizer implements ListSelectionListener {
+    static class ChangesetDetailViewSynchronizer implements ListSelectionListener {
+        private final ChangesetCacheManagerModel model;
+
+        ChangesetDetailViewSynchronizer(ChangesetCacheManagerModel model) {
+            this.model = model;
+        }
+
         @Override
         public void valueChanged(ListSelectionEvent e) {

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/ChangesetQueryDialog.java

@@ -6 +6 @@
 import java.awt.BorderLayout;
 import java.awt.Container;
-import java.awt.Dialog;
 import java.awt.Dimension;
 import java.awt.FlowLayout;
-import java.awt.Frame;
+import java.awt.Window;
 import java.awt.event.ActionEvent;
 import java.awt.event.KeyEvent;
@@ -95 +94 @@
     }
 
-    public ChangesetQueryDialog(Dialog parent) {
-        super(parent, ModalityType.DOCUMENT_MODAL);
-        build();
-    }
-
-    public ChangesetQueryDialog(Frame parent) {
+    public ChangesetQueryDialog(Window parent) {
         super(parent, ModalityType.DOCUMENT_MODAL);
         build();

trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java

@@ -27 +27 @@
 import java.lang.reflect.InvocationTargetException;
 import java.util.Enumeration;
+import java.util.EventObject;
 import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
@@ -463 +464 @@
         return GraphicsEnvironment.isHeadless() ? null : Toolkit.getDefaultToolkit().getSystemSelection();
     }
+
+    /**
+     * Returns the first <code>Window</code> ancestor of event source, or
+     * {@code null} if event source is not a component contained inside a <code>Window</code>.
+     * @param e event object
+     * @return a Window, or {@code null}
+     * @since 9916
+     */
+    public static Window getWindowAncestorFor(EventObject e) {
+        return e != null && e.getSource() instanceof Component ? SwingUtilities.getWindowAncestor((Component) e.getSource()) : null;
+    }
 }

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -8 +8 @@
 import java.awt.Color;
 import java.awt.Font;
+import java.awt.HeadlessException;
 import java.awt.Toolkit;
 import java.awt.datatransfer.Clipboard;
@@ -635 +636 @@
      */
     public static String getClipboardContent() {
-        Transferable t = getTransferableContent(Toolkit.getDefaultToolkit().getSystemClipboard());
         try {
+            Transferable t = getTransferableContent(Toolkit.getDefaultToolkit().getSystemClipboard());
             if (t != null && t.isDataFlavorSupported(DataFlavor.stringFlavor)) {
                 return (String) t.getTransferData(DataFlavor.stringFlavor);
             }
-        } catch (UnsupportedFlavorException | IOException ex) {
+        } catch (UnsupportedFlavorException | IOException | HeadlessException ex) {
             Main.error(ex);
             return null;