Changeset 9676 in josm for trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java

Timestamp:

2016-01-29T22:18:37+01:00 (8 years ago)

Author:

Don-vip

Message:

javadoc, findbugs

File:

• trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java

@@ -24 +24 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
+/**
+ * Abstract superclass of save actions.
+ * @since 290
+ */
 public abstract class SaveActionBase extends DiskAccessAction {
     private File file;
 
+    /**
+     * Constructs a new {@code SaveActionBase}.
+     * @param name The action's text as displayed on the menu (if it is added to a menu)
+     * @param iconName The filename of the icon to use
+     * @param tooltip A longer description of the action that will be displayed in the tooltip
+     * @param shortcut A ready-created shortcut object or {@code null} if you don't want a shortcut
+     */
     public SaveActionBase(String name, String iconName, String tooltip, Shortcut shortcut) {
         super(name, iconName, tooltip, shortcut);
@@ -38 +49 @@
     }
 
+    /**
+     * Saves the active layer.
+     * @return {@code true} if the save operation succeeds
+     */
     public boolean doSave() {
         if (Main.isDisplayingMapView()) {
@@ -48 +63 @@
     }
 
+    /**
+     * Saves the given layer.
+     * @param layer layer to save
+     * @return {@code true} if the save operation succeeds
+     */
     public boolean doSave(Layer layer) {
         if (!layer.checkSaveConditions())
@@ -160 +180 @@
      *
      * @param fc FileChooser where file was already selected
+     * @param extension file extension
      * @return the {@code File} or {@code null} if the user cancelled the dialog.
      */
     public static File checkFileAndConfirmOverWrite(AbstractFileChooser fc, String extension) {
-        if (fc == null) return null;
+        if (fc == null)
+            return null;
         File file = fc.getSelectedFile();
 
@@ -190 +212 @@
     }
 
+    /**
+     * Asks user to confirm overwiting a file.
+     * @param file file to overwrite
+     * @return {@code true} if the file can be written
+     */
     public static boolean confirmOverwrite(File file) {
-        if (file == null || (file.exists())) {
+        if (file == null || file.exists()) {
             ExtendedDialog dialog = new ExtendedDialog(
                     Main.parent,
@@ -210 +237 @@
             filepath = file.getCanonicalPath();
         } catch (IOException ign) {
+            Main.warn(ign);
             return;
         }