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

Timestamp:

2014-08-14T11:27:38+02:00 (10 years ago)

Author:

Don-vip

Message:

code cleanup, javadoc update

File:

• trunk/src/org/openstreetmap/josm/data/osm/MultipolygonBuilder.java (moved) (moved from trunk/src/org/openstreetmap/josm/data/osm/MultipolygonCreate.java ) (10 diffs)

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

@@ -16 +16 @@
 import org.openstreetmap.josm.tools.MultiMap;
 
-public class MultipolygonCreate {
+/**
+ * Helper class to build multipolygons from multiple ways.
+ * @author viesturs
+ * @since 7392 (rename)
+ * @since 3704
+ */
+public class MultipolygonBuilder {
 
     /**
      * Represents one polygon that consists of multiple ways.
-     * @author Viesturs
-     *
      */
     public static class JoinedPolygon {
@@ -29 +33 @@
         public final Area area;
 
+        /**
+         * Constructs a new {@code JoinedPolygon} from given list of ways.
+         * @param ways The ways used to build joined polygon
+         */
         public JoinedPolygon(List<Way> ways, List<Boolean> reversed) {
             this.ways = ways;
@@ -55 +63 @@
                 boolean reversed = this.reversed.get(waypos).booleanValue();
 
-                if (!reversed){
+                if (!reversed) {
                     for (int pos = 0; pos < way.getNodesCount() - 1; pos++) {
                         nodes.add(way.getNode(pos));
@@ -71 +79 @@
     }
 
-
     /**
      * Helper storage class for finding findOuterWays
-     * @author viesturs
      */
     static class PolygonLevel {
@@ -89 +95 @@
     }
 
-    public List<JoinedPolygon> outerWays;
-    public List<JoinedPolygon> innerWays;
-
-    public MultipolygonCreate(List<JoinedPolygon> outerWays, List<JoinedPolygon> innerWays){
+    /** List of outer ways **/
+    public final List<JoinedPolygon> outerWays;
+    /** List of inner ways **/
+    public final List<JoinedPolygon> innerWays;
+
+    /**
+     * Constructs a new {@code MultipolygonBuilder} initialized with given ways.
+     * @param outerWays The outer ways
+     * @param innerWays The inner ways
+     */
+    public MultipolygonBuilder(List<JoinedPolygon> outerWays, List<JoinedPolygon> innerWays) {
         this.outerWays = outerWays;
         this.innerWays = innerWays;
     }
 
-    public MultipolygonCreate(){
+    /**
+     * Constructs a new empty {@code MultipolygonBuilder}.
+     */
+    public MultipolygonBuilder() {
         this.outerWays = new ArrayList<>(0);
         this.innerWays = new ArrayList<>(0);
@@ -122 +138 @@
      */
     public static class JoinedPolygonCreationException extends RuntimeException {
+        /**
+         * Constructs a new {@code JoinedPolygonCreationException}.
+         * @param message the detail message. The detail message is saved for
+         *                later retrieval by the {@link #getMessage()} method
+         */
         public JoinedPolygonCreationException(String message) {
             super(message);
@@ -159 +180 @@
         //process unclosed ways
         for (Way startWay: ways) {
-            if (usedWays.contains(startWay)){
+            if (usedWays.contains(startWay)) {
                 continue;
             }
@@ -191 +212 @@
 
                 Way nextWay = null;
-                for(Way way: adjacentWays){
-                    if (way != curWay){
+                for(Way way: adjacentWays) {
+                    if (way != curWay) {
                         nextWay = way;
                     }
@@ -217 +238 @@
         List<PolygonLevel> list = findOuterWaysRecursive(0, polygons);
 
-        if (list == null){
+        if (list == null) {
             return tr("There is an intersection between ways.");
         }
 
-        this.outerWays = new ArrayList<>(0);
-        this.innerWays = new ArrayList<>(0);
+        this.outerWays.clear();
+        this.innerWays.clear();
 
         //take every other level
@@ -265 +286 @@
                     innerCandidates.add(innerWay);
                 }
-                else if (intersection == PolygonIntersection.CROSSING)
-                {
+                else if (intersection == PolygonIntersection.CROSSING) {
                     //ways intersect
                     return null;