Changeset 9854 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2016-02-23T02:11:42+01:00 (8 years ago)

Author:

Don-vip

Message:

sonar - squid:S2272 - "Iterator.next()" methods should throw "NoSuchElementException" + javadoc/code style

Location:

trunk/src/org/openstreetmap/josm/data

Files:

• gpx/GpxData.java (modified) (6 diffs)
• osm/QuadBuckets.java (modified) (10 diffs)
• osm/visitor/paint/StyledMapRenderer.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/gpx/GpxData.java

@@ -11 +11 @@
 import java.util.List;
 import java.util.Map;
+import java.util.NoSuchElementException;
 import java.util.Set;
 
@@ -32 +33 @@
     public boolean fromServer;
 
+    /** Creator (usually software) */
     public String creator;
 
+    /** Tracks */
     public final Collection<GpxTrack> tracks = new LinkedList<>();
+    /** Routes */
     public final Collection<GpxRoute> routes = new LinkedList<>();
+    /** Waypoints */
     public final Collection<WayPoint> waypoints = new LinkedList<>();
 
@@ -46 +51 @@
     public final Set<DataSource> dataSources = new HashSet<>();
 
+    /**
+     * Merges data from another object.
+     * @param other existing GPX data
+     */
     public void mergeFrom(GpxData other) {
         if (storageFile == null && other.storageFile != null) {
@@ -361 +370 @@
     }
 
+    /**
+     * Resets the internal caches of east/north coordinates.
+     */
     public void resetEastNorthCache() {
         if (waypoints != null) {
@@ -401 +413 @@
         private final boolean[] trackVisibility;
 
+        /**
+         * Constructs a new {@code LinesIterator}.
+         * @param data GPX data
+         * @param trackVisibility An array indicating which tracks should be
+         * included in the iteration. Can be null, then all tracks are included.
+         */
         public LinesIterator(GpxData data, boolean[] trackVisibility) {
             itTracks = data.tracks.iterator();
@@ -416 +434 @@
         @Override
         public Collection<WayPoint> next() {
+            if (!hasNext()) {
+                throw new NoSuchElementException();
+            }
             Collection<WayPoint> current = next;
             next = getNext();

trunk/src/org/openstreetmap/josm/data/osm/QuadBuckets.java

@@ -7 +7 @@
 import java.util.Iterator;
 import java.util.List;
+import java.util.NoSuchElementException;
 
 import org.openstreetmap.josm.Main;
@@ -475 +476 @@
     }
 
+    /**
+     * Converts to list.
+     * @return elements as list
+     */
     public List<T> toList() {
         List<T> a = new ArrayList<>();
@@ -498 +503 @@
         private int iteratedOver;
 
-        final QBLevel<T> next_content_node(QBLevel<T> q) {
+        final QBLevel<T> nextContentNode(QBLevel<T> q) {
             if (q == null)
                 return null;
@@ -514 +519 @@
                 currentNode = qb.root;
             } else {
-                currentNode = next_content_node(qb.root);
+                currentNode = nextContentNode(qb.root);
             }
             iteratedOver = 0;
@@ -531 +536 @@
             while ((currentNode.content == null) || (contentIndex >= currentNode.content.size())) {
                 contentIndex = 0;
-                currentNode = next_content_node(currentNode);
+                currentNode = nextContentNode(currentNode);
                 if (currentNode == null) {
                     break;
@@ -544 +549 @@
         public T next() {
             T ret = peek();
+            if (ret == null)
+                throw new NoSuchElementException();
             contentIndex++;
             iteratedOver++;
@@ -576 +583 @@
     }
 
-    public List<T> search(BBox search_bbox) {
+    public List<T> search(BBox searchBbox) {
         List<T> ret = new ArrayList<>();
         // Doing this cuts down search cost on a real-life data set by about 25%
@@ -583 +590 @@
         }
         // Walk back up the tree when the last search spot can not cover the current search
-        while (searchCache != null && !searchCache.bbox().bounds(search_bbox)) {
+        while (searchCache != null && !searchCache.bbox().bounds(searchBbox)) {
             searchCache = searchCache.parent;
         }
@@ -589 +596 @@
         if (searchCache == null) {
             searchCache = root;
-            Main.info("bbox: " + search_bbox + " is out of the world");
+            Main.info("bbox: " + searchBbox + " is out of the world");
         }
 
@@ -595 +602 @@
         QBLevel<T> tmp = searchCache.parent;
 
-        searchCache.search(search_bbox, ret);
+        searchCache.search(searchBbox, ret);
 
         // A way that spans this bucket may be stored in one
         // of the nodes which is a parent of the search cache
         while (tmp != null) {
-            tmp.search_contents(search_bbox, ret);
+            tmp.search_contents(searchBbox, ret);
             tmp = tmp.parent;
         }

trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/StyledMapRenderer.java

@@ -33 +33 @@
 import java.util.List;
 import java.util.Map;
+import java.util.NoSuchElementException;
 import java.util.concurrent.ForkJoinPool;
 import java.util.concurrent.ForkJoinTask;
@@ -94 +95 @@
      *
      * There is no intention, to handle consecutive duplicate Nodes in a
-     * perfect way, but it is should not throw an exception.
+     * perfect way, but it should not throw an exception.
      */
     private class OffsetIterator implements Iterator<Point> {
@@ -122 +123 @@
         @Override
         public Point next() {
-            if (Math.abs(offset) < 0.1d) return nc.getPoint(nodes.get(idx++));
+            if (!hasNext())
+                throw new NoSuchElementException();
+
+            if (Math.abs(offset) < 0.1d)
+                return nc.getPoint(nodes.get(idx++));
 
             Point current = nc.getPoint(nodes.get(idx));