Changeset 29384 in osm for applications/editors/josm/plugins/imagery_offset_db/src/iodb/GetImageryOffsetAction.java

Timestamp:

2013-03-22T22:18:26+01:00 (12 years ago)

Author:

zverik

Message:

ImageryID refactoring and javadocs

File:

• applications/editors/josm/plugins/imagery_offset_db/src/iodb/GetImageryOffsetAction.java (modified) (6 diffs)

applications/editors/josm/plugins/imagery_offset_db/src/iodb/GetImageryOffsetAction.java

@@ -20 +20 @@
  * Download a list of imagery offsets for the current position, let user choose which one to use.
  * 
- * @author zverik
+ * @author Zverik
+ * @license WTFPL
  */
 public class GetImageryOffsetAction extends JosmAction {
     
+    /**
+     * Initialize the action. Sets "Ctrl+Alt+I" shortcut: the only shortcut in this plugin.
+     */
     public GetImageryOffsetAction() {
         super(tr("Get Imagery Offset..."), "getoffset", tr("Download offsets for current imagery from a server"),
@@ -30 +34 @@
     }
 
+    /**
+     * The action just executes {@link DownloadOffsetsTask}.
+     */
     public void actionPerformed(ActionEvent e) {
         if( Main.map == null || Main.map.mapView == null || !Main.map.isVisible() )
@@ -44 +51 @@
     }
 
+    /**
+     * This action is enabled when there's a map, mapView and one of the layers
+     * is an imagery layer.
+     */
     @Override
     protected void updateEnabledState() {
@@ -55 +66 @@
     }
     
-    private void showOffsetDialog( List<ImageryOffsetBase> offsets, ImageryLayer layer ) {
+    /**
+     * Display a dialog for choosing between offsets. If there are no offsets in
+     * the list, displays the relevant message instead.
+     * @param offsets List of offset objects to choose from.
+     */
+    private void showOffsetDialog( List<ImageryOffsetBase> offsets ) {
         if( offsets.isEmpty() ) {
             JOptionPane.showMessageDialog(Main.parent,
@@ -67 +83 @@
     }
 
+    /**
+     * A task that downloads offsets for a given position and imagery layer,
+     * then parses resulting XML and calls
+     * {@link #showOffsetDialog(java.util.List)} on success.
+     */
     class DownloadOffsetsTask extends SimpleOffsetQueryTask {
         private ImageryLayer layer;
         private List<ImageryOffsetBase> offsets;
 
+        /**
+         * Initializes query object from the parameters.
+         * @param center A center point of a map view.
+         * @param layer The topmost imagery layer.
+         * @param imagery Imagery ID for the layer.
+         */
         public DownloadOffsetsTask( LatLon center, ImageryLayer layer, String imagery ) {
             super(null, tr("Loading imagery offsets..."));
@@ -87 +114 @@
         }
 
+        /**
+         * Displays offset dialog on success.
+         */
         @Override
         protected void afterFinish() {
             if( !cancelled && offsets != null )
-                showOffsetDialog(offsets, layer);
+                showOffsetDialog(offsets);
         }
         
+        /**
+         * Parses the response with {@link IODBReader}.
+         * @param inp Response input stream.
+         * @throws iodb.SimpleOffsetQueryTask.UploadException Thrown on XML parsing error.
+         */
         @Override
         protected void processResponse( InputStream inp ) throws UploadException {