Changeset 6222 in josm for trunk

Timestamp:

2013-09-08T05:14:39+02:00 (11 years ago)

Author:

Don-vip

Message:

Make some more defensive copies of user-supplied arrays, javadoc

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/projection/datum/NTV2SubGrid.java (modified) (4 diffs)
• gui/conflict/pair/ComparePairType.java (modified) (2 diffs)
• gui/history/TwoColumnDiff.java (modified) (5 diffs)
• gui/preferences/projection/ListProjectionChoice.java (modified) (3 diffs)
• io/auth/CredentialsAgentResponse.java (modified) (2 diffs)
• tools/Utils.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java

@@ -23 +23 @@
 import java.io.InputStream;
 import java.io.Serializable;
+
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -216 +218 @@
      * @param gs GridShift object containing the coordinate to shift and the shift values
      * @return the GridShift object supplied, with values updated.
-     * @throws IOException
      */
     public NTV2GridShift interpolateGridShift(NTV2GridShift gs) {
@@ -281 +282 @@
      */
     public void setSubGridArray(NTV2SubGrid[] subGrid) {
-        this.subGrid = subGrid;
+        this.subGrid = Utils.copyArray(subGrid);
     }
 
@@ -369 +370 @@
         return minLon;
     }
-
 }

trunk/src/org/openstreetmap/josm/gui/conflict/pair/ComparePairType.java

@@ -5 +5 @@
 import static org.openstreetmap.josm.gui.conflict.pair.ListRole.THEIR_ENTRIES;
 import static org.openstreetmap.josm.tools.I18n.tr;
+
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -33 +35 @@
     ComparePairType(String displayName, ListRole[] participatingRoles) {
         this.displayName = displayName;
-        this.participatingRoles = participatingRoles;
+        this.participatingRoles = Utils.copyArray(participatingRoles);
     }
 

trunk/src/org/openstreetmap/josm/gui/history/TwoColumnDiff.java

@@ -8 +8 @@
 import org.openstreetmap.josm.gui.history.TwoColumnDiff.Item.DiffItemType;
 import org.openstreetmap.josm.tools.Diff;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -54 +55 @@
     Object[] current;
 
-    /**
-     * The arguments will _not_ be modified
-     */
     public TwoColumnDiff(Object[] reference, Object[] current) {
-        this.reference = reference;
-        this.current = current;
+        this.reference = Utils.copyArray(reference);
+        this.current = Utils.copyArray(current);
         referenceDiff = new ArrayList<Item>();
         currentDiff = new ArrayList<Item>();
         diff();
     }
+    
     private void diff() {
         Diff diff = new Diff(reference, current);
@@ -82 +81 @@
             int inserted = script.inserted;
             while(ia < script.line0 && ib < script.line1){
-                // System.out.println(" "+a[ia] + "\t "+b[ib]);
                 Item cell = new Item(DiffItemType.SAME, a[ia]);
                 referenceDiff.add(cell);
@@ -92 +90 @@
             while(inserted > 0 || deleted > 0) {
                 if(inserted > 0 && deleted > 0) {
-                    // System.out.println("="+a[ia] + "\t="+b[ib]);
                     referenceDiff.add(new Item(DiffItemType.CHANGED, a[ia++]));
                     currentDiff.add(new Item(DiffItemType.CHANGED, b[ib++]));
                 } else if(inserted > 0) {
-                    // System.out.println("\t+" + b[ib]);
                     referenceDiff.add(new Item(DiffItemType.EMPTY, null));
                     currentDiff.add(new Item(DiffItemType.INSERTED, b[ib++]));
                 } else if(deleted > 0) {
-                    // System.out.println("-"+a[ia]);
                     referenceDiff.add(new Item(DiffItemType.DELETED, a[ia++]));
                     currentDiff.add(new Item(DiffItemType.EMPTY, null));
@@ -110 +105 @@
         }
         while(ia < a.length && ib < b.length) {
-            // System.out.println((ia < a.length ? " "+a[ia]+"\t" : "\t") + (ib < b.length ? " "+b[ib] : ""));
             referenceDiff.add(new Item(DiffItemType.SAME, a[ia++]));
             currentDiff.add(new Item(DiffItemType.SAME, b[ib++]));

trunk/src/org/openstreetmap/josm/gui/preferences/projection/ListProjectionChoice.java

@@ -12 +12 @@
 import org.openstreetmap.josm.gui.widgets.JosmComboBox;
 import org.openstreetmap.josm.tools.GBC;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -24 +25 @@
 
     /**
-     * Constructor
+     * Constructs a new {@code ListProjectionChoice}.
      *
      * @param name the display name
@@ -34 +35 @@
     public ListProjectionChoice(String name, String id, Object[] entries, String label, int defaultIndex) {
         super(name, id);
-        this.entries = entries;
+        this.entries = Utils.copyArray(entries);
         this.label = label;
         this.defaultIndex = defaultIndex;
     }
 
+    /**
+     * Constructs a new {@code ListProjectionChoice}.
+     * @param name the display name
+     * @param id the unique id for this ProjectionChoice
+     * @param entries the list of display entries for the combo-box
+     * @param label a label shown left to the combo-box
+     */
     public ListProjectionChoice(String name, String id, Object[] entries, String label) {
         this(name, id, entries, label, 0);

trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgentResponse.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.io.auth;
+
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -42 +44 @@
      */
     public void setPassword(char[] password) {
-        this.password = password;
+        this.password = Utils.copyArray(password);
     }
     /**

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

@@ -256 +256 @@
     
     /**
+     * Copies the given array. Unlike {@link Arrays#copyOf}, this method is null-safe.
+     * @param array The array to copy
+     * @return A copy of the original array, or {@code null} if {@code array} is null
+     * @since 6222
+     */
+    public static char[] copyArray(char[] array) {
+        if (array != null) {
+            return Arrays.copyOf(array, array.length);
+        }
+        return null;
+    }
+    
+    /**
      * Simple file copy function that will overwrite the target file.<br/>
      * Taken from <a href="http://www.rgagnon.com/javadetails/java-0064.html">this article</a> (CC-NC-BY-SA)
@@ -715 +728 @@
         return all.toString();
     }
-
 }