Changeset 12675 in josm for trunk/src/org/openstreetmap/josm/gui/progress

Timestamp:

2017-08-27T18:12:20+02:00 (7 years ago)

Author:

Don-vip

Message:

see #15182 - move the Swing-based ProgressMonitor implementations from gui.progress to gui.progress.swing. Progress monitor concept is used in very large parts of JOSM, a console-based implementation could be added later

Location:

trunk/src/org/openstreetmap/josm/gui/progress

Files:

• AbstractProgressMonitor.java (modified) (1 diff)
• ProgressRenderer.java (modified) (1 diff)
• swing (added)
• swing/PleaseWaitProgressMonitor.java (moved) (moved from trunk/src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java ) (3 diffs)
• swing/ProgressMonitorExecutor.java (moved) (moved from trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitorExecutor.java ) (2 diffs)
• swing/SwingRenderingProgressMonitor.java (moved) (moved from trunk/src/org/openstreetmap/josm/gui/progress/SwingRenderingProgressMonitor.java ) (2 diffs)
• swing/package-info.java (added)

trunk/src/org/openstreetmap/josm/gui/progress/AbstractProgressMonitor.java

@@ -27 +27 @@
     private final CancelHandler cancelHandler;
 
-    protected enum State {
+    /**
+     * Progress monitor state
+     * @since 12675 (visibility)
+     */
+    public enum State {
+        /** Initialization. Next valid states are {@link #IN_TASK} or {@link #FINISHED} */
         INIT,
+        /** In task. Next valid states are {@link #IN_SUBTASK} or {@link #FINISHED} */
         IN_TASK,
+        /** In subtask. Next valid states is {@link #IN_TASK} */
         IN_SUBTASK,
+        /** Finished. Can't change state after that */
         FINISHED
     }

trunk/src/org/openstreetmap/josm/gui/progress/ProgressRenderer.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.progress;
+
+import org.openstreetmap.josm.gui.progress.swing.SwingRenderingProgressMonitor;
 
 /**

trunk/src/org/openstreetmap/josm/gui/progress/swing/PleaseWaitProgressMonitor.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.gui.progress;
+package org.openstreetmap.josm.gui.progress.swing;
 
 import java.awt.Component;
@@ -16 +16 @@
 import org.openstreetmap.josm.gui.MapStatus.BackgroundProgressMonitor;
 import org.openstreetmap.josm.gui.PleaseWaitDialog;
+import org.openstreetmap.josm.gui.progress.AbstractProgressMonitor;
+import org.openstreetmap.josm.gui.progress.CancelHandler;
+import org.openstreetmap.josm.gui.progress.ProgressException;
+import org.openstreetmap.josm.gui.progress.ProgressTaskId;
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.tools.bugreport.BugReport;
@@ -23 +27 @@
  * <p>
  * Progress is displayed in a dialog window ({@link PleaseWaitDialog}).
+ * @since 12675 (moved from {@code gui.progress} package}
  */
 public class PleaseWaitProgressMonitor extends AbstractProgressMonitor {

trunk/src/org/openstreetmap/josm/gui/progress/swing/ProgressMonitorExecutor.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.gui.progress;
+package org.openstreetmap.josm.gui.progress.swing;
 
 import java.util.concurrent.LinkedBlockingQueue;
@@ -13 +13 @@
  * Similar to Executors.newSingleThreadExecutor(), but displays the
  * progress monitor whenever a new task is executed.
+ * @since 12675 (moved from {@code gui.progress} package}
  */
 public class ProgressMonitorExecutor extends ThreadPoolExecutor {

trunk/src/org/openstreetmap/josm/gui/progress/swing/SwingRenderingProgressMonitor.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.gui.progress;
+package org.openstreetmap.josm.gui.progress.swing;
 
 import java.awt.Component;
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.gui.progress.AbstractProgressMonitor;
+import org.openstreetmap.josm.gui.progress.CancelHandler;
+import org.openstreetmap.josm.gui.progress.ProgressRenderer;
+import org.openstreetmap.josm.gui.progress.ProgressTaskId;
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
@@ -12 +16 @@
  * of progress information to a {@link ProgressRenderer}.
  * Methods of the progress renderer are always called on the Swing EDT.
- *
+ * @since 12675 (moved from {@code gui.progress} package}
  */
 public class SwingRenderingProgressMonitor extends AbstractProgressMonitor {