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

Timestamp:

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

Author:

zverik

Message:

ImageryID refactoring and javadocs

File:

• applications/editors/josm/plugins/imagery_offset_db/src/iodb/DeprecateOffsetAction.java (modified) (4 diffs)

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

@@ -12 +12 @@
 
 /**
- * Download a list of imagery offsets for the current position, let user choose which one to use.
+ * A context-dependent action to deprecate an offset.
  * 
- * @author zverik
+ * @author Zverik
+ * @license WTFPL
  */
 public class DeprecateOffsetAction extends AbstractAction {
@@ -20 +21 @@
     private QuerySuccessListener listener;
     
+    /**
+     * Initialize an action with an offset object.
+     */
     public DeprecateOffsetAction( ImageryOffsetBase offset ) {
         super(tr("Deprecate Offset"));
@@ -27 +31 @@
     }
 
+    /**
+     * Asks a user if they really want to deprecate an offset (since this
+     * action is virtually irreversible) and calls
+     * {@link #deprecateOffset(iodb.ImageryOffsetBase, iodb.QuerySuccessListener)}
+     * on a positive answer.
+     */
     public void actionPerformed(ActionEvent e) {
         if( Main.map == null || Main.map.mapView == null || !Main.map.isVisible() )
@@ -41 +51 @@
     }
 
+    /**
+     * Installs a listener to process successful deprecation event.
+     */
     public void setListener( QuerySuccessListener listener ) {
         this.listener = listener;
     }
 
+    /**
+     * Deprecate the given offset.
+     * @see #deprecateOffset(iodb.ImageryOffsetBase, iodb.QuerySuccessListener) 
+     */
     public static void deprecateOffset( ImageryOffsetBase offset ) {
         deprecateOffset(offset, null);
     }
 
+    /**
+     * Deprecate the given offset and call listener on success. Asks user the reason
+     * and executes {@link SimpleOffsetQueryTask} with a query to deprecate the offset.
+     */
     public static void deprecateOffset( ImageryOffsetBase offset, QuerySuccessListener listener ) {
         String userName = JosmUserIdentityManager.getInstance().getUserName();