Changeset 11272 in josm for trunk/src/org/openstreetmap/josm/data/osm/BBox.java

Timestamp:

2016-11-17T21:00:49+01:00 (7 years ago)

Author:

michael2402

Message:

See #13361: Cleanup code and formatting

• Add javadoc to public methods
• Add @since tag to newer methods
• Do not use if (...) return true; else return false;
• Remove parentheses if they are not required
• Use blocks for if-statements which is more consistent with most of JOSM code

File:

• trunk/src/org/openstreetmap/josm/data/osm/BBox.java (modified) (11 diffs)

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

@@ -6 +6 @@
 import java.util.Objects;
 
+import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.coor.QuadTiling;
 import org.openstreetmap.josm.tools.Utils;
 
+/**
+ * A BBox represents an area in lat/lon space. It is used for the quad tree.
+ *
+ * In contrast to a {@link Bounds} object, a BBox can represent an invalid (empty) area.
+ */
 public class BBox {
 
@@ -30 +36 @@
      */
     public BBox(final double x, final double y) {
-        if (!Double.isNaN(x) && !Double.isNaN(y)) {
-            xmin = x;
-            ymin = y;
-            xmax = x;
-            ymax = y;
-        }
+        add(x, y);
     }
 
@@ -69 +70 @@
      */
     public BBox(double ax, double ay, double bx, double by) {
-        if (Double.isNaN(ax) || Double.isNaN(ay) || Double.isNaN(bx) || Double.isNaN(by)) {
-            return; // use default which is an invalid BBox
-        }
-
-        if (ax > bx) {
-            xmax = ax;
-            xmin = bx;
-        } else {
-            xmax = bx;
-            xmin = ax;
-        }
-
-        if (ay > by) {
-            ymax = ay;
-            ymin = by;
-        } else {
-            ymax = by;
-            ymin = ay;
-        }
+        if (!(Double.isNaN(ax) || Double.isNaN(ay) || Double.isNaN(bx) || Double.isNaN(by))) {
+            add(ax, ay);
+            add(bx, by);
+        }
+        // otherwise use default which is an invalid BBox
     }
 
@@ -96 +83 @@
      */
     public BBox(Way w) {
-        w.getNodes().forEach((n) -> add(n.getCoor()));
+        w.getNodes().forEach(n -> add(n.getCoor()));
     }
 
@@ -104 +91 @@
      */
     public BBox(Node n) {
-        if (n.isLatLonKnown())
+        if (n.isLatLonKnown()) {
             add(n.getCoor());
+        }
     }
 
@@ -114 +102 @@
      */
     public final void add(LatLon c) {
-        if (c != null && c.isValid())
+        if (c != null && c.isValid()) {
             add(c.lon(), c.lat());
+        }
     }
 
@@ -124 +113 @@
      */
     public final void add(double x, double y) {
-        if (Double.isNaN(x) || Double.isNaN(y))
-            return;
-        xmin = Math.min(xmin, x);
-        xmax = Math.max(xmax, x);
-        ymin = Math.min(ymin, y);
-        ymax = Math.max(ymax, y);
+        if (!Double.isNaN(x) && !Double.isNaN(y)) {
+            xmin = Math.min(xmin, x);
+            xmax = Math.max(xmax, x);
+            ymin = Math.min(ymin, y);
+            ymax = Math.max(ymax, y);
+        }
     }
 
@@ -156 +145 @@
     }
 
+    /**
+     * Gets the height of the bbox.
+     * @return The difference between ymax and ymin. 0 for invalid bboxes.
+     */
     public double height() {
-        return ymax-ymin;
-    }
-
+        if (isValid()) {
+            return ymax - ymin;
+        } else {
+            return 0;
+        }
+    }
+
+    /**
+     * Gets the width of the bbox.
+     * @return The difference between xmax and xmin. 0 for invalid bboxes.
+     */
     public double width() {
-        return xmax-xmin;
+        if (isValid()) {
+            return xmax - xmin;
+        } else {
+            return 0;
+        }
     }
 
@@ -191 +196 @@
      */
     public boolean intersects(BBox b) {
-        if (xmin > b.xmax)
-            return false;
-        if (xmax < b.xmin)
-            return false;
-        if (ymin > b.ymax)
-            return false;
-        if (ymax < b.ymin)
-            return false;
-        return true;
+        return xmin <= b.xmax && xmax >= b.xmin
+            && ymin <= b.ymax && ymax >= b.ymin;
     }
 
@@ -254 +252 @@
     }
 
+    /**
+     * Gets the center of this BBox.
+     * @return The center.
+     */
     public LatLon getCenter() {
         return new LatLon(ymin + (ymax-ymin)/2.0, xmin + (xmax-xmin)/2.0);
@@ -298 +300 @@
      * @return true if the bbox covers a part of the planets surface
      * Height and width must be non-negative, but may (both) be 0.
+     * @since 11269
      */
     public boolean isValid() {
-        return (xmin <= xmax && ymin <= ymax);
-    }
-
-    /**
-     * @return true if the bbox covers a part of the planets surface
+        return xmin <= xmax && ymin <= ymax;
+    }
+
+    /**
+     * @return true if the bbox  is avalid and covers a part of the planets surface
+     * @since 11269
      */
     public boolean isInWorld() {
-        return !(xmin < -180.0 || xmax > 180.0 || ymin < -90.0 || ymax > 90.0);
+        return isValid() && xmin >= -180.0 && xmax <= 180.0 && ymin >= -90.0 && ymax <= 90.0;
     }