Changeset 10910 in josm

Timestamp:

2016-08-28T19:00:16+02:00 (8 years ago)

Author:

Don-vip

Message:

improve javadoc, unit tests, reduce visibility of some public fields

Location:

trunk

Files:

• src/org/openstreetmap/josm/actions/DownloadOsmInViewAction.java (modified) (1 diff)
• src/org/openstreetmap/josm/data/Bounds.java (modified) (5 diffs)
• src/org/openstreetmap/josm/gui/MapViewState.java (modified) (1 diff)
• src/org/openstreetmap/josm/gui/dialogs/RelationListDialog.java (modified) (3 diffs)
• src/org/openstreetmap/josm/gui/mappaint/mapcss/ConditionFactory.java (modified) (7 diffs)
• test/unit/org/openstreetmap/josm/data/BoundsTest.java (modified) (2 diffs)

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

@@ -44 +44 @@
 
     private static class DownloadOsmInViewTask extends DownloadOsmTask {
-        public Future<?> download(Bounds downloadArea) {
+        Future<?> download(Bounds downloadArea) {
             return download(new DownloadTask(false, new BoundingBoxDownloader(downloadArea), null, false), downloadArea);
         }

trunk/src/org/openstreetmap/josm/data/Bounds.java

@@ -89 +89 @@
     }
 
+    /**
+     * Constructs bounds out of two points.
+     * @param min min lat/lon
+     * @param max max lat/lon
+     * @param roundToOsmPrecision defines if lat/lon will be rounded
+     */
     public Bounds(LatLon min, LatLon max, boolean roundToOsmPrecision) {
         this(min.lat(), min.lon(), max.lat(), max.lon(), roundToOsmPrecision);
@@ -94 +100 @@
 
     /**
-     * Constructs bounds out a single point.
+     * Constructs bounds out a single point. Coords will be rounded.
      * @param b lat/lon
      */
@@ -134 +140 @@
     }
 
+    /**
+     * Constructs bounds out of two points. Coords will be rounded.
+     * @param minlat min lat
+     * @param minlon min lon
+     * @param maxlat max lat
+     * @param maxlon max lon
+     */
     public Bounds(double minlat, double minlon, double maxlat, double maxlon) {
         this(minlat, minlon, maxlat, maxlon, true);
     }
 
+    /**
+     * Constructs bounds out of two points.
+     * @param minlat min lat
+     * @param minlon min lon
+     * @param maxlat max lat
+     * @param maxlon max lon
+     * @param roundToOsmPrecision defines if lat/lon will be rounded
+     */
     public Bounds(double minlat, double minlon, double maxlat, double maxlon, boolean roundToOsmPrecision) {
         if (roundToOsmPrecision) {
@@ -152 +173 @@
     }
 
+    /**
+     * Constructs bounds out of two points. Coords will be rounded.
+     * @param coords exactly 4 values: min lat, min lon, max lat, max lon
+     * @throws IllegalArgumentException if coords does not contain 4 double values
+     */
     public Bounds(double ... coords) {
         this(coords, true);
     }
 
+    /**
+     * Constructs bounds out of two points.
+     * @param coords exactly 4 values: min lat, min lon, max lat, max lon
+     * @param roundToOsmPrecision defines if lat/lon will be rounded
+     * @throws IllegalArgumentException if coords does not contain 4 double values
+     */
     public Bounds(double[] coords, boolean roundToOsmPrecision) {
         CheckParameterUtil.ensureParameterNotNull(coords, "coords");
@@ -232 +264 @@
     }
 
+    /**
+     * Creates new {@code Bounds} from a rectangle.
+     * @param rect The rectangle
+     */
     public Bounds(Rectangle2D rect) {
         this(rect.getMinY(), rect.getMinX(), rect.getMaxY(), rect.getMaxX());

trunk/src/org/openstreetmap/josm/gui/MapViewState.java

@@ -264 +264 @@
     }
 
+    /**
+     * Returns the area for the given bounds.
+     * @param bounds bounds
+     * @return the area for the given bounds
+     */
     public Area getArea(Bounds bounds) {
         Path2D area = new Path2D.Double();

trunk/src/org/openstreetmap/josm/gui/dialogs/RelationListDialog.java

@@ -388 +388 @@
     /**
      * The list model for the list of relations displayed in the relation list dialog.
-     *
      */
     private class RelationListModel extends AbstractListModel<Relation> {
@@ -400 +399 @@
         }
 
+        /**
+         * Clears the model.
+         */
         public void clear() {
             relations.clear();
@@ -407 +409 @@
         }
 
+        /**
+         * Sorts the model using {@link DefaultNameFormatter} relation comparator.
+         */
         public void sort() {
             relations.sort(DefaultNameFormatter.getInstance().getRelationComparator());

trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ConditionFactory.java

@@ -332 +332 @@
         final Pattern pattern;
 
+        /**
+         * Constructs a new {@code KeyValueRegexpCondition}.
+         * @param k key
+         * @param v value
+         * @param op operation
+         * @param considerValAsKey must be false
+         */
         public KeyValueRegexpCondition(String k, String v, Op op, boolean considerValAsKey) {
             super(k, v, op, considerValAsKey);
@@ -361 +368 @@
     public static class RegexpKeyValueRegexpCondition extends KeyValueRegexpCondition {
 
-        public final Pattern keyPattern;
+        final Pattern keyPattern;
 
         /**
@@ -386 +393 @@
 
     public static class RoleCondition implements Condition {
-        public final String role;
-        public final Op op;
-
+        final String role;
+        final Op op;
+
+        /**
+         * Constructs a new {@code RoleCondition}.
+         * @param role role
+         * @param op operation
+         */
         public RoleCondition(String role, Op op) {
             this.role = role;
@@ -403 +415 @@
 
     public static class IndexCondition implements Condition {
-        public final String index;
-        public final Op op;
-
+        final String index;
+        final Op op;
+
+        /**
+         * Constructs a new {@code IndexCondition}.
+         * @param index index
+         * @param op operation
+         */
         public IndexCondition(String index, Op op) {
             this.index = index;
@@ -548 +565 @@
 
         public final String id;
-        public final boolean not;
+        final boolean not;
 
         public ClassCondition(String id, boolean not) {
@@ -740 +757 @@
     public static class PseudoClassCondition implements Condition {
 
-        public final Method method;
-        public final boolean not;
+        final Method method;
+        final boolean not;
 
         protected PseudoClassCondition(Method method, boolean not) {
@@ -810 +827 @@
     public static class ExpressionCondition implements Condition {
 
-        private final Expression e;
+        final Expression e;
 
         /**

trunk/test/unit/org/openstreetmap/josm/data/BoundsTest.java

@@ -5 +5 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
+
+import java.awt.geom.Rectangle2D;
 
 import org.junit.Test;
@@ -47 +49 @@
         assertEquals(b3, new Bounds(0, 0, 90, -170));
     }
+
+    private static void doTestConstructorNominal(Bounds b) {
+        double eps = 1e-7;
+        assertEquals(1d, b.getMinLat(), eps);
+        assertEquals(2d, b.getMinLon(), eps);
+        assertEquals(3d, b.getMaxLat(), eps);
+        assertEquals(4d, b.getMaxLon(), eps);
+    }
+
+    private static void doTestConstructorPoint(Bounds b) {
+        double eps = 1e-7;
+        assertEquals(1d, b.getMinLat(), eps);
+        assertEquals(2d, b.getMinLon(), eps);
+        assertEquals(1d, b.getMaxLat(), eps);
+        assertEquals(2d, b.getMaxLon(), eps);
+    }
+
+    /**
+     * Unit tests for {@link Bounds#Bounds} - nominal cases.
+     */
+    @Test
+    public void testConstructorNominalCases() {
+        doTestConstructorNominal(new Bounds(new LatLon(1d, 2d), new LatLon(3d, 4d)));
+        doTestConstructorNominal(new Bounds(new LatLon(1d, 2d), new LatLon(3d, 4d), true));
+        doTestConstructorNominal(new Bounds(1d, 2d, 3d, 4d));
+        doTestConstructorNominal(new Bounds(1d, 2d, 3d, 4d, true));
+        doTestConstructorNominal(new Bounds(new double[]{1d, 2d, 3d, 4d}));
+        doTestConstructorNominal(new Bounds(new double[]{1d, 2d, 3d, 4d}, true));
+        doTestConstructorNominal(new Bounds(new Bounds(1d, 2d, 3d, 4d)));
+        doTestConstructorNominal(new Bounds(new Rectangle2D.Double(2d, 1d, 2d, 2d)));
+    }
+
+    /**
+     * Unit tests for {@link Bounds#Bounds} - single point cases.
+     */
+    @Test
+    public void testConstructorSinglePointCases() {
+        doTestConstructorPoint(new Bounds(new LatLon(1d, 2d)));
+        doTestConstructorPoint(new Bounds(new LatLon(1d, 2d), true));
+        doTestConstructorPoint(new Bounds(1d, 2d, true));
+    }
 }